Created
May 23, 2025 11:28
-
-
Save jp26jp/74fc147e8bb70c7c3640a6ea3965c6c7 to your computer and use it in GitHub Desktop.
ReZEN Endpoints
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "https://keymaker.therealbrokerage.com/api/v1/users/{id}/email": { | |
| "put": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Update email for a given user", | |
| "operationId": "updateEmailForUser", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.UpdateEmailRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/users/email": { | |
| "put": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Update email", | |
| "operationId": "updateEmail", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.UpdateEmailRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/mfa/signin-with-mfa": { | |
| "post": { | |
| "tags": [ | |
| "mfa-controller" | |
| ], | |
| "summary": "Login with multi factor authentication code", | |
| "operationId": "signInWithMfa", | |
| "parameters": [ | |
| { | |
| "name": "X-real-app-name", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.MfaVerificationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.JwtAuthenticationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/mfa/enable-mfa": { | |
| "post": { | |
| "tags": [ | |
| "mfa-controller" | |
| ], | |
| "summary": "Enable multi factor authentication", | |
| "operationId": "enableMfa", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.EnableMfaRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.ApiResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/mfa/enable-mfa-and-signin": { | |
| "post": { | |
| "tags": [ | |
| "mfa-controller" | |
| ], | |
| "summary": "Enable multi factor authentication and login", | |
| "operationId": "enableMfaAndSignIn", | |
| "parameters": [ | |
| { | |
| "name": "X-real-app-name", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.EnableMfaRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.JwtAuthenticationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/auth/updatepassword": { | |
| "post": { | |
| "tags": [ | |
| "auth-controller" | |
| ], | |
| "summary": "Update Existing Password", | |
| "operationId": "updatePassword", | |
| "parameters": [ | |
| { | |
| "name": "X-real-app-name", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.UpdateExistingPasswordRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/auth/signout": { | |
| "post": { | |
| "tags": [ | |
| "auth-controller" | |
| ], | |
| "summary": "Sign Out", | |
| "operationId": "signOut", | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/auth/signin": { | |
| "post": { | |
| "tags": [ | |
| "auth-controller" | |
| ], | |
| "summary": "Login", | |
| "operationId": "authenticateUser", | |
| "parameters": [ | |
| { | |
| "name": "X-real-app-name", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.LoginRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.JwtAuthenticationResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/auth/resetpassword": { | |
| "post": { | |
| "tags": [ | |
| "auth-controller" | |
| ], | |
| "summary": "ResetPassword", | |
| "operationId": "resetPassword", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.ResetPasswordRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.ResetPasswordResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/auth/forgotpassword": { | |
| "post": { | |
| "tags": [ | |
| "auth-controller" | |
| ], | |
| "summary": "ForgotPassword", | |
| "operationId": "forgotpassword", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.ResetPasswordRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/auth/changepassword": { | |
| "post": { | |
| "tags": [ | |
| "auth-controller" | |
| ], | |
| "summary": "Change Password", | |
| "operationId": "changePassword", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.PasswordUpdateRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "object" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/api-keys": { | |
| "get": { | |
| "tags": [ | |
| "api-key-controller" | |
| ], | |
| "summary": "Get all API keys for current user", | |
| "operationId": "getApiKeys", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Keymaker.ApiKeyResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "api-key-controller" | |
| ], | |
| "summary": "Generate API key", | |
| "operationId": "generateApiKey", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.GenerateApiKeyRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.ApiKeyResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "api-key-controller" | |
| ], | |
| "summary": "Revoke API key", | |
| "operationId": "revokeApiKey", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.RevokeApiKeyRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.ApiKeyResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/users/{id}": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get user's login information", | |
| "operationId": "getIdentity", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.IdentitySummaryResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/mfa/send-mfa-sms": { | |
| "get": { | |
| "tags": [ | |
| "mfa-controller" | |
| ], | |
| "summary": "Send multi factor authentication code to phone", | |
| "operationId": "sendMfaSms", | |
| "parameters": [ | |
| { | |
| "name": "phoneNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.ApiResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/mfa/mfa-qr-code": { | |
| "get": { | |
| "tags": [ | |
| "mfa-controller" | |
| ], | |
| "summary": "Get Authenticator QR code", | |
| "operationId": "getAuthenticatorQrCode", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/keymaker/public": { | |
| "get": { | |
| "tags": [ | |
| "key-maker-controller" | |
| ], | |
| "operationId": "publicApiCall", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/keymaker/protected": { | |
| "get": { | |
| "tags": [ | |
| "key-maker-controller" | |
| ], | |
| "operationId": "protectedApiCall", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/keymaker/myself": { | |
| "get": { | |
| "tags": [ | |
| "key-maker-controller" | |
| ], | |
| "summary": "Get current user", | |
| "operationId": "getCurrentUser", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.IdentitySummaryResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/keymaker/mfa-protected": { | |
| "get": { | |
| "tags": [ | |
| "key-maker-controller" | |
| ], | |
| "operationId": "mfaProtectedApiCall", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [], | |
| "mfa": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/auth/verify/{token}": { | |
| "get": { | |
| "tags": [ | |
| "auth-controller" | |
| ], | |
| "summary": "Auth Exchange with Auth Token", | |
| "operationId": "verifyToken", | |
| "parameters": [ | |
| { | |
| "name": "token", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.UserPrincipal" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/auth/checkusernameavailability": { | |
| "get": { | |
| "tags": [ | |
| "auth-controller" | |
| ], | |
| "summary": "Check if username is available", | |
| "operationId": "checkUsernameAvailability", | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.IdentityAvailability" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/auth/checkemailavailability": { | |
| "get": { | |
| "tags": [ | |
| "auth-controller" | |
| ], | |
| "summary": "Check if email is available", | |
| "operationId": "checkEmailAvailability", | |
| "parameters": [ | |
| { | |
| "name": "email", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.IdentityAvailability" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "https://keymaker.therealbrokerage.com/api/v1/mfa": { | |
| "delete": { | |
| "tags": [ | |
| "mfa-controller" | |
| ], | |
| "summary": "Disable/Delete multi factor authentication for self", | |
| "operationId": "deleteMfa", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.MfaVerificationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Keymaker.ApiResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/updateVerified": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update verified a Transaction by id", | |
| "operationId": "updateTransactionVerified", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateTransactionVerifiedRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/undo-termination-request": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Undo Termination Request", | |
| "operationId": "undoTerminationRequest", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/termination-requested": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Transition transaction to 'Termination Requested'", | |
| "operationId": "transitionToTerminationRequested", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/tax-exempt": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update tax exempt status on a Transaction by id", | |
| "operationId": "updateTaxExemptStatus", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateTransactionTaxExemptStatusRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/recalculate": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Recalculate commission (hard reset)", | |
| "operationId": "recalculateCommission", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/ready-for-cd-generation": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Transition transaction to 'Ready for Commission Document Generation'", | |
| "operationId": "transitionToReadyForCommissionDocumentGeneration", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/payouts": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Set payouts", | |
| "operationId": "setPayouts", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.SetPaymentsRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/payment-accepted": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Transition transaction to 'Payment Accepted'", | |
| "operationId": "transitionToPaymentAccepted", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/pay-paid-at-closing": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Pay to participants marked as 'paid-at-closing'", | |
| "operationId": "payPaidAtClosing", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.PayPaidAtClosingRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participants/{teammateParticipantId}/team-fees": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get pro-teammate team fees", | |
| "operationId": "getProTeammateTeamFees", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "teammateParticipantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ProTeammateTeamFeesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update pro-teammate's team fees", | |
| "operationId": "updateProTeammateTeamFees", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "teammateParticipantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateProTeammateTeamFeesRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participants/{teammateParticipantId}/pro-teammate-commission-splits": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get pro-teammate commission splits to leaders", | |
| "operationId": "getProTeammateCommissionSplits", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "teammateParticipantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ProTeammateCommissionSplitsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update pro-teammate commission splits to leaders", | |
| "operationId": "updateProTeammateCommissionSplits", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "teammateParticipantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateProTeammateCommissionSplits" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participants/{teammateParticipantId}/fee-splits": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get pro-teammate's fee splits", | |
| "operationId": "getProTeammateFeeSplits", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "teammateParticipantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ProTeammateFeeSplitsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update pro-teammate's fee splits", | |
| "operationId": "updateProTeammateFeeSplits", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "teammateParticipantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateProTeammateFeeSplitsRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participant/{participantId}": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update transaction participant", | |
| "operationId": "updateParticipant", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateParticipantRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "remove participant", | |
| "operationId": "removeParticipant", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participant/{participantId}/tax-withheld": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update transaction's participant tax withheld status", | |
| "operationId": "updatePaymentParticipantTaxWithheldStatus", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdatePaymentParticipantTaxWithheldStatusRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participant/{participantId}/instant-payment-eligibility": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update transaction's participant instant payment eligibility", | |
| "operationId": "updateParticipantInstantPaymentEligibility", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateParticipantInstantPaymentEligibilityRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/onboarded": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update onboarded a Transaction by id", | |
| "operationId": "updateTransactionOnboarded", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateTransactionOnboardedRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/new": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Transition transaction to 'New'", | |
| "operationId": "transitionToNew", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/firm-date": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update Firm Date", | |
| "operationId": "updateFirmDateForTransaction", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateTransactionFirmDateRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/escrows/{escrowId}/escrow-deposit/{escrowDepositId}/receipts": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get deposit installment receipt", | |
| "operationId": "getInstallmentReceipt", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "escrowId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "escrowDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Upload deposit installment receipt", | |
| "operationId": "uploadInstallmentReceipt", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "escrowId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "escrowDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "receipt" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "receipt": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/double-ender-agent": { | |
| "put": { | |
| "tags": [ | |
| "double-ender-controller" | |
| ], | |
| "summary": "Add double-ender agent to the transaction", | |
| "operationId": "addDoubleEnderAgent", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.DoubleEnderAddAgentRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "double-ender-controller" | |
| ], | |
| "summary": "Removes the double-ender agent from the transaction, unlinking if necessary", | |
| "operationId": "deleteDoubleEnderAgent", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/commission-validated": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Transition transaction to 'Commission Validated'", | |
| "operationId": "transitionToCommissionValidated", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/closed": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Transition transaction to 'Closed'", | |
| "operationId": "transitionToClosed", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/check-deposits/{amount}": { | |
| "put": { | |
| "tags": [ | |
| "check-deposits-controller" | |
| ], | |
| "summary": "Upload Check deposit", | |
| "operationId": "uploadCheck", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "amount", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "check-image-back", | |
| "check-image-front" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "check-image-front": { | |
| "type": "string", | |
| "format": "binary" | |
| }, | |
| "check-image-back": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CheckDepositUploadResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/certify-closing": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Certifies the transaction closing", | |
| "operationId": "certifyClosing", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionClosingCertificationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/cd-approved": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Transition transaction to 'Commission Document Approved'", | |
| "operationId": "transitionToCommissionDocumentApproved", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/attached-fee/{attachedFeeId}": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update a transaction's attached fee", | |
| "operationId": "updateAttachedFee", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "attachedFeeId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AttachedFeeRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Delete an attached fee on the transaction", | |
| "operationId": "deleteAttachedFee", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "attachedFeeId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{id}/location": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "update address, mls and escrow values", | |
| "operationId": "updateLocation", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.LocationInfoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{id}/fmls": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update whether this Transaction is listed on FMLS", | |
| "operationId": "updateFmlsInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.FmlsInfoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{id}/deal": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update price, date, sale/listing commissions, office and representee", | |
| "operationId": "updateDealInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateDealRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/participant/{participantId}/w9": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get participant's W9 url", | |
| "operationId": "getW9Url", | |
| "parameters": [ | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Upload W9 of external transaction participant", | |
| "operationId": "uploadW9", | |
| "parameters": [ | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "file" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "file": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/escrows/{escrowId}": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update Escrow", | |
| "operationId": "updateEscrow", | |
| "parameters": [ | |
| { | |
| "name": "escrowId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Delete Escrow", | |
| "operationId": "deleteEscrow", | |
| "parameters": [ | |
| { | |
| "name": "escrowId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ApiResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/escrows/{escrowId}/received": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Received Escrow", | |
| "operationId": "receivedEscrow", | |
| "parameters": [ | |
| { | |
| "name": "escrowId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/escrows/{escrowId}/check-deposits/{amount}": { | |
| "put": { | |
| "tags": [ | |
| "check-deposits-controller" | |
| ], | |
| "summary": "Upload Check deposit for an escrow (trust deposit)", | |
| "operationId": "uploadEscrowDepositCheck", | |
| "parameters": [ | |
| { | |
| "name": "escrowId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "amount", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "check-image-back", | |
| "check-image-front" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "check-image-front": { | |
| "type": "string", | |
| "format": "binary" | |
| }, | |
| "check-image-back": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CheckDepositUploadResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/escrows/escrow-deposit/{escrowDepositId}": { | |
| "put": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update an escrow deposit", | |
| "operationId": "updateEscrowDeposit", | |
| "parameters": [ | |
| { | |
| "name": "escrowDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowDepositRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Delete an escrow deposit", | |
| "operationId": "deleteEscrowDeposit", | |
| "parameters": [ | |
| { | |
| "name": "escrowDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/title": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update Title Details", | |
| "operationId": "updateTitleInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TitleInfoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/seller": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add a new seller", | |
| "operationId": "addSeller", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.SellerInfo" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/referral-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add referral info", | |
| "operationId": "addReferralInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "role", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "REAL", | |
| "BUYERS_AGENT", | |
| "TENANT_AGENT", | |
| "REFERRING_AGENT", | |
| "SELLERS_AGENT", | |
| "OTHER_AGENT", | |
| "EXTERNAL_AGENT", | |
| "TEAM_LEADER", | |
| "TEAM_MEMBER", | |
| "DOMESTIC_LEAD", | |
| "TRANSACTION_COORDINATOR", | |
| "ADMIN", | |
| "INSPECTION", | |
| "ESCROW", | |
| "TITLE", | |
| "LANDLORD", | |
| "MANAGEMENT_COMPANY", | |
| "ATTORNEY", | |
| "APPRAISER", | |
| "HOME_WARRANTY", | |
| "LENDER", | |
| "BUYER", | |
| "SELLER", | |
| "TENANT", | |
| "OTHER", | |
| "UNKNOWN", | |
| "REFERRAL_PAYER", | |
| "SELLERS_LAWYER", | |
| "BUYERS_LAWYER", | |
| "TRUSTEE", | |
| "REAL_ADMIN", | |
| "BUILDER", | |
| "PRO_TEAM_LEADER" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "firstName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "lastName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "receivesInvoice", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "EXTERNAL_ENTITY", | |
| "AGENT" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "companyName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "email", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "ein", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "phoneNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "address", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "file": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| }, | |
| "*/*": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "file": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/referral-info/{participantId}/upload-w9": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Upload W9 to external referral participant", | |
| "operationId": "uploadW9ToExternalReferralParticipant", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "file" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "file": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/price-date-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update price and date", | |
| "operationId": "updatePriceAndDateInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.PriceAndDateInfoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/personal-deal-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update personal deal info", | |
| "operationId": "updatePersonalDealInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.PersonalDealInfoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/owner-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update owner info", | |
| "operationId": "updateOwnerAgentInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionOwnerAgentInfoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/other-participants": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add a new participant to the transaction builder", | |
| "operationId": "addParticipant", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AddParticipantRequest" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/opcity": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add opcity to transaction builder", | |
| "operationId": "addOpcity", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "opcity", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/mortgage-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update mortgage info", | |
| "operationId": "updateMortgageInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.MortgageInfoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/location-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update location info", | |
| "operationId": "updateLocationInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.LocationInfoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/fmls": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update whether this builder's property is listed on FMLS", | |
| "operationId": "updateFmlsInfo_1", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.FmlsInfoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/double-ender-agent": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add double-ender agent to the transaction builder", | |
| "operationId": "addDoubleEnderAgent_1", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AddDoubleEnderAgentRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/commission-payer": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add commission info", | |
| "operationId": "addCommissionPayer", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionPayerInfoRequest" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/commission-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update commission Splits info", | |
| "operationId": "updateCommissionSplits", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionSplitsRequest" | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/co-agent": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add a new co-agent", | |
| "operationId": "addCoAgent", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentParticipantInfo" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/buyer": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add a new buyer", | |
| "operationId": "addBuyer", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.BuyerInfo" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/buyer-seller-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update buyer and seller", | |
| "operationId": "updateBuyerAndSellerInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.BuyerAndSellerRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/additional-fees-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Update additional fees info", | |
| "operationId": "updateAdditionalFeesInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AdditionalFeesRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/add-referral-info": { | |
| "put": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add referral info", | |
| "operationId": "addReferralInfo_1", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AddParticipantRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.BuilderParticipant" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/refunds/{id}": { | |
| "put": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Update an existing refund", | |
| "operationId": "updateRefund", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateRefundRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RefundResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/refunds/replace-attachment/{attachmentId}": { | |
| "put": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Replaces an attachment for refund", | |
| "operationId": "replaceAttachment", | |
| "parameters": [ | |
| { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "attachment" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "attachment": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RefundAttachmentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/referrals/{referralId}/applicant-agents/{agentId}": { | |
| "put": { | |
| "tags": [ | |
| "referral-central-referral-controller" | |
| ], | |
| "summary": "Add a referral applicant agent", | |
| "operationId": "updateApplicantAgent", | |
| "parameters": [ | |
| { | |
| "name": "referralId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "hidden", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ApplicantAgentDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "referral-central-referral-controller" | |
| ], | |
| "summary": "Remove a referral applicant agent", | |
| "operationId": "deleteApplicantAgent", | |
| "parameters": [ | |
| { | |
| "name": "referralId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/referrals/{id}": { | |
| "get": { | |
| "tags": [ | |
| "referral-central-referral-controller" | |
| ], | |
| "summary": "Get a Referral Central referral by ID", | |
| "operationId": "fetchReferralById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralCentralReferralDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "referral-central-referral-controller" | |
| ], | |
| "summary": "Update a Referral Central referral", | |
| "operationId": "updateReferral", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralCentralReferralDto" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "500": { | |
| "description": "Internal Server Error", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralCentralReferralDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "referral-central-referral-controller" | |
| ], | |
| "summary": "Delete a Referral Central referral by ID", | |
| "operationId": "deleteReferral", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/outgoing-payments/{outgoingPaymentId}": { | |
| "get": { | |
| "tags": [ | |
| "outgoing-payments-controller" | |
| ], | |
| "summary": "Get Outgoing Payment", | |
| "operationId": "getOutgoingPayment", | |
| "parameters": [ | |
| { | |
| "name": "outgoingPaymentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.OutgoingPaymentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/money-transfers/{moneyTransferId}": { | |
| "get": { | |
| "tags": [ | |
| "money-transfer-controller" | |
| ], | |
| "summary": "Get Money Transfer By Id", | |
| "operationId": "getMoneyTransferById", | |
| "parameters": [ | |
| { | |
| "name": "moneyTransferId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.MoneyTransferResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/listings/{listingId}/transition/{lifecycleState}": { | |
| "put": { | |
| "tags": [ | |
| "listing-controller" | |
| ], | |
| "summary": "transition to desired state", | |
| "operationId": "transitionTransaction", | |
| "parameters": [ | |
| { | |
| "name": "listingId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "lifecycleState", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "NEW", | |
| "CALCULATE_LEDGER", | |
| "NEEDS_COMMISSION_VALIDATION", | |
| "COMMISSION_VALIDATED", | |
| "READY_FOR_COMMISSION_DOCUMENT_GENERATION", | |
| "COMMISSION_DOCUMENT_GENERATED", | |
| "COMMISSION_DOCUMENT_APPROVED", | |
| "COMMISSION_DOCUMENT_SENT", | |
| "APPROVED_FOR_CLOSING", | |
| "CLOSED", | |
| "WAITING_ON_PAYMENT", | |
| "PAYMENT_ACCEPTED", | |
| "PAYMENT_SCHEDULED", | |
| "SETTLED", | |
| "TERMINATION_REQUESTED", | |
| "TERMINATED", | |
| "LISTING_ACTIVE", | |
| "LISTING_IN_CONTRACT", | |
| "LISTING_CLOSED" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/commission-advances/{commissionAdvanceId}": { | |
| "get": { | |
| "tags": [ | |
| "commission-advances-controller" | |
| ], | |
| "summary": "Update Commission Advance", | |
| "operationId": "getCommissionAdvance", | |
| "parameters": [ | |
| { | |
| "name": "commissionAdvanceId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionAdvanceResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/referral/{referralId}": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update referral", | |
| "operationId": "updateReferral_1", | |
| "parameters": [ | |
| { | |
| "name": "referralId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Delete a referral", | |
| "operationId": "deleteReferral_1", | |
| "parameters": [ | |
| { | |
| "name": "referralId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ApiResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/referral/{referralId}/upload-attachment": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update referral attachment", | |
| "operationId": "updateReferralAttachment", | |
| "parameters": [ | |
| { | |
| "name": "referralId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "file" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "file": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent-debts/{id}": { | |
| "get": { | |
| "tags": [ | |
| "agent-debt-controller" | |
| ], | |
| "summary": "Get agent debt", | |
| "operationId": "getAgentDebt", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentDebtResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v2/tax-docs/{agentYentaId}/{year}": { | |
| "get": { | |
| "tags": [ | |
| "tax-document-controller-v-2" | |
| ], | |
| "summary": "Get the tax documents for a particular year for an agent", | |
| "operationId": "getTaxDocumentsForAgentByYear", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "year", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.TaxDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "tax-document-controller-v-2" | |
| ], | |
| "summary": "Generate (or regenerate) the given year's tax documents for an agent", | |
| "operationId": "generateTaxDocuments", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "year", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TaxDocumentsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/users/{userId}/transaction-coordinator/statistics": { | |
| "post": { | |
| "tags": [ | |
| "user-stats-controller" | |
| ], | |
| "summary": "Get transaction coordinator Listings and transactions agent wise counts.", | |
| "operationId": "getStatistics", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionCoordinatorStatisticsRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionCoordinatorStatisticsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/title": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Returns information about the title progress for a given transaction", | |
| "operationId": "getTitleProgress", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TitleProgress" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Onboards the given transaction with Real Title (Qualia) for title processing, using the agent's user", | |
| "operationId": "enableTitle", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TitleOnboardingResultDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Removes the transaction from title services", | |
| "operationId": "cancelTitle", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/title/system-user": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Onboards the given transaction with Real Title (Qualia) for title processing, using the system user", | |
| "operationId": "enableTitleSystemUser", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TitleOnboardingResultDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/title-order": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Places Title order for the transaction with the contract file attachment", | |
| "operationId": "placeTitleOrder", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.PlaceTitleOrderRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.PlaceTitleOrderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participant": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "add participant", | |
| "operationId": "addParticipant_1", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CreateParticipantRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participant/opcity": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "add participant", | |
| "operationId": "addOpcityParticipant", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/escrow": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Create Escrow", | |
| "operationId": "createEscrow", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/double-ender": { | |
| "get": { | |
| "tags": [ | |
| "double-ender-controller" | |
| ], | |
| "summary": "Get double-ender transactions info", | |
| "operationId": "getDoubleEnderTransactionsInfo", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.DoubleEnderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/create-participant": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Create transaction participant", | |
| "operationId": "createParticipant", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CreateParticipantRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ParticipantResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/check-deposits/{checkDepositId}": { | |
| "get": { | |
| "tags": [ | |
| "check-deposits-controller" | |
| ], | |
| "summary": "Get transaction check deposit", | |
| "operationId": "getTransactionCheckDeposit", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "checkDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CheckDepositDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "check-deposits-controller" | |
| ], | |
| "summary": "Submit Check deposit", | |
| "operationId": "submitCheck", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "checkDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CheckDepositSubmitRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CheckDepositSubmitResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/attached-fee": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Create an attached fee on the transaction", | |
| "operationId": "createAttachedFee", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AttachedFeeRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/agent-reported-transaction-closed-dialog": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Submit data collected by the \"Has this Transaction Closed?\" modal dialog", | |
| "operationId": "submitAgentReportedTransactionClosedDialog", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentReportedTransactionClosedDialogRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/lite/batch-get": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Returns an array of TransactionLiteResponses for a given array of transaction IDs", | |
| "operationId": "getTransactionLiteResponsesForIds", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.BatchGetTransactionLiteRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.BulkTransactionLiteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/escrows/{escrowId}/escrow-deposit": { | |
| "post": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Deposit a payment for an escrow (trust deposit)", | |
| "operationId": "receivedEscrowDeposit", | |
| "parameters": [ | |
| { | |
| "name": "escrowId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowDepositRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/escrows/{escrowId}/check-deposits/{checkDepositId}": { | |
| "post": { | |
| "tags": [ | |
| "check-deposits-controller" | |
| ], | |
| "summary": "Submit Check deposit for an escrow (trust deposit)", | |
| "operationId": "submitEscrowDepositCheck", | |
| "parameters": [ | |
| { | |
| "name": "escrowId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "checkDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CheckDepositSubmitRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CheckDepositSubmitResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder": { | |
| "get": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Get a paginated list of transaction builders", | |
| "operationId": "getTransactionBuilders", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "from", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "yentaId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "TRANSACTION", | |
| "enum": [ | |
| "TRANSACTION", | |
| "LISTING" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "dealType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "COMPENSATING", | |
| "REFERRAL", | |
| "SALE", | |
| "LEASE", | |
| "COMMERCIAL_LEASE", | |
| "PLOT", | |
| "OTHER", | |
| "INTERNAL_REFERRAL" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "create empty transactionBuilder", | |
| "operationId": "initializeTransactionBuilder", | |
| "parameters": [ | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "TRANSACTION", | |
| "enum": [ | |
| "TRANSACTION", | |
| "LISTING" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/transaction-to-builder": { | |
| "post": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "create transactionBuilder from given transaction ", | |
| "operationId": "createBuilderFromTransaction", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/transaction-coordinator/{yentaId}": { | |
| "post": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Add Transaction Coordinator to transaction builder", | |
| "operationId": "addTransactionCoordinator", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Remove Transaction Coordinator from transaction builder", | |
| "operationId": "removeTransactionCoordinator", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/submit": { | |
| "post": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Submits a TransactionBuilder to create a Transaction", | |
| "operationId": "submitTransaction", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionPreviewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/tax-docs/{agentYentaId}/{year}": { | |
| "get": { | |
| "tags": [ | |
| "tax-document-controller" | |
| ], | |
| "summary": "Get the tax document for a particular year for an agent", | |
| "operationId": "getTaxDocumentForAgentByYear", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "year", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TaxDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "tax-document-controller" | |
| ], | |
| "summary": "Generate (or regenerate) the given year's tax document for an agent", | |
| "operationId": "generateTaxDocument", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "year", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TaxDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/sentiment/display-sentiment": { | |
| "post": { | |
| "tags": [ | |
| "sentiment-controller" | |
| ], | |
| "summary": "Saves info about Sentiment display and returns display status for current context", | |
| "operationId": "displaySentiment", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.SentimentDisplayRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.SentimentDisplayResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/sentiment/agent/{agentId}/sentiment": { | |
| "post": { | |
| "tags": [ | |
| "sentiment-controller" | |
| ], | |
| "summary": "Creates new Sentiment for current context", | |
| "operationId": "createSentiment", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "X-real-app-name", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "X-real-app-version", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CreateSentimentRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.SentimentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/sentiment/agent/{agentId}/display-sentiment": { | |
| "post": { | |
| "tags": [ | |
| "sentiment-controller" | |
| ], | |
| "summary": "Saves info about Sentiment display and returns display status for current context", | |
| "operationId": "displaySentiment_1", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.SentimentDisplayRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.SentimentDisplayResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/refunds": { | |
| "get": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Get Refunds By Transaction Id", | |
| "operationId": "getRefundsByTransactionId", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.RefundResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Submit Refund Request", | |
| "operationId": "createRefundRequest", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CreateRefundRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CreateRefundResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/refunds/{id}/attachment": { | |
| "post": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Uploads an attachment for refund", | |
| "operationId": "uploadAttachment", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "description", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "attachment" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "attachment": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RefundAttachmentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/referrals": { | |
| "get": { | |
| "tags": [ | |
| "referral-central-referral-controller" | |
| ], | |
| "summary": "Filter and sort paginated referrals", | |
| "operationId": "findReferrals", | |
| "parameters": [ | |
| { | |
| "name": "request", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralSearchRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.PagedReferralResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "referral-central-referral-controller" | |
| ], | |
| "summary": "Create a Referral Central referral", | |
| "operationId": "createReferral", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralCentralReferralDto" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/money-transfers": { | |
| "get": { | |
| "tags": [ | |
| "money-transfer-controller" | |
| ], | |
| "summary": "Get All Money Transfers", | |
| "operationId": "getAllMoneyTransfers", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.MoneyTransferResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/instant-payment/agent/{agentId}/terms-and-conditions": { | |
| "post": { | |
| "tags": [ | |
| "instant-payment-controller" | |
| ], | |
| "summary": "Agree to Instant Payment Terms and Conditions", | |
| "operationId": "agreeToTermsAndConditions", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/instant-payment/agent/{agentId}/instant-payment": { | |
| "post": { | |
| "tags": [ | |
| "instant-payment-controller" | |
| ], | |
| "summary": "Create Instant Payment", | |
| "operationId": "createInstantPayment", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CreateInstantPaymentRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/instant-payment/agent/{agentId}/eligible-instant-payment/fees": { | |
| "post": { | |
| "tags": [ | |
| "instant-payment-controller" | |
| ], | |
| "summary": "Get eligible instant payment line items for transaction", | |
| "operationId": "getEligiblePaymentItems", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.InstantPaymentItemRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.InstantPaymentEligibleItemsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cdas/{transactionId}/generate-for-transaction-id": { | |
| "post": { | |
| "tags": [ | |
| "commission-document-controller" | |
| ], | |
| "summary": "Generate trade record sheet by id", | |
| "operationId": "generateTradeRecordSheetByTransactionId", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cdas/{id}/sign": { | |
| "post": { | |
| "tags": [ | |
| "commission-document-controller" | |
| ], | |
| "summary": "Sign commission document by id", | |
| "operationId": "signCommissionDocument", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.SignRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentYentaId}/referral": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Create referral", | |
| "operationId": "createReferral_1", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentYentaId}/referral-and-disburse": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Create and disburse referral", | |
| "operationId": "createAndDisburseReferral", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CreateAndDisburseReferralRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CreateAndDisburseReferralResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentYentaId}/connectToSkyslope": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Connect user to skyslope", | |
| "operationId": "connectToSkySlope", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent-debts": { | |
| "get": { | |
| "tags": [ | |
| "agent-debt-controller" | |
| ], | |
| "summary": "Get agent debts", | |
| "operationId": "getAgentDebts", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "debtStatuses", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "PAID", | |
| "CANCELLED" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "debtSources", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "SYSTEM_GENERATED", | |
| "MANUAL" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "debtTypes", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "GARNISHMENT", | |
| "TRANSACTION", | |
| "OPCITY", | |
| "BOUNCED_CHECK", | |
| "FINES", | |
| "TAXES", | |
| "MLS_FEE", | |
| "COMPANY_LOAN", | |
| "LEGAL_ORDER", | |
| "LUXURY", | |
| "CREDIT", | |
| "LATE_FEE", | |
| "COMMISSION_ADVANCE", | |
| "EARLY_COMMISSION_PAYMENT", | |
| "INSTANT_PAYMENT", | |
| "BOARD_FEE", | |
| "JOIN_FEE", | |
| "LICENSE_TRANSFER_FEE" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "debtRecoveryTypes", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "INVOICE", | |
| "COMMISSION", | |
| "REVSHARE", | |
| "ALL_PAYMENTS" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "debtRecurrences", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "DAILY", | |
| "WEEKLY", | |
| "MONTHLY", | |
| "YEARLY" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "sourceIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "recurringDebtsOnly", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| }, | |
| { | |
| "name": "latestRecurringDebtsOnly", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "PRECEDENCE", | |
| "CREATED_AT", | |
| "UPDATED_AT" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentDebtsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participant/{participantId}/lite": { | |
| "patch": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Update transaction participant with fields that do not require ledger recalculation", | |
| "operationId": "updateParticipantLite", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.UpdateParticipantLiteRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/title-contract": { | |
| "delete": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Delete Title Contract/Purchase Agreement", | |
| "operationId": "deleteTitleContract", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Upload Title Contract/Purchase Agreement", | |
| "operationId": "uploadTitleContractAgreement", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "file" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "file": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/mortgage-ecp-opt-out": { | |
| "patch": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Mortgage early commission payment opt-out", | |
| "operationId": "optOutOfMortgageEarlyCommission", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/mortgage-ecp-opt-in": { | |
| "patch": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Mortgage early commission payment opt-in", | |
| "operationId": "optInForMortgageEarlyCommission", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{txId}/transaction-explanation": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Verbose explanation of just transaction without participant payout explanations", | |
| "operationId": "explainTransaction", | |
| "parameters": [ | |
| { | |
| "name": "txId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionExplanationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{txId}/payout-explanation": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Verbose explanation of the transaction and all its participant payouts", | |
| "operationId": "explainTransactionAndParticipantPayouts", | |
| "parameters": [ | |
| { | |
| "name": "txId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionPayoutExplanationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{txId}/payout-explanation/{participantId}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Verbose explanation of participant's payout in the transaction", | |
| "operationId": "explainParticipantPayout", | |
| "parameters": [ | |
| { | |
| "name": "txId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.PayoutExplanationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{txId}/metadata-for-participant-creation/{participantRole}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Metadata required to create a participant", | |
| "operationId": "getCreateParticipantMetadata", | |
| "parameters": [ | |
| { | |
| "name": "txId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "participantRole", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "REAL", | |
| "BUYERS_AGENT", | |
| "TENANT_AGENT", | |
| "REFERRING_AGENT", | |
| "SELLERS_AGENT", | |
| "OTHER_AGENT", | |
| "EXTERNAL_AGENT", | |
| "TEAM_LEADER", | |
| "TEAM_MEMBER", | |
| "DOMESTIC_LEAD", | |
| "TRANSACTION_COORDINATOR", | |
| "ADMIN", | |
| "INSPECTION", | |
| "ESCROW", | |
| "TITLE", | |
| "LANDLORD", | |
| "MANAGEMENT_COMPANY", | |
| "ATTORNEY", | |
| "APPRAISER", | |
| "HOME_WARRANTY", | |
| "LENDER", | |
| "BUYER", | |
| "SELLER", | |
| "TENANT", | |
| "OTHER", | |
| "UNKNOWN", | |
| "REFERRAL_PAYER", | |
| "SELLERS_LAWYER", | |
| "BUYERS_LAWYER", | |
| "TRUSTEE", | |
| "REAL_ADMIN", | |
| "BUILDER", | |
| "PRO_TEAM_LEADER" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ParticipantCreationMetadataResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get Transaction by id", | |
| "operationId": "getTransaction", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/title-order/placement-eligibility": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Gets title order placement eligibility info for transaction", | |
| "operationId": "checkTitleOrderPlacementEligibility", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TitleOrderPlacementEligibilityResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/summary-pdf": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Download a transaction summary PDF", | |
| "operationId": "downloadTransactionSummaryPDF", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/process": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Process transaction", | |
| "operationId": "processTransaction", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/permissions": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get transaction's permissions", | |
| "operationId": "getPermissions", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionPermissionsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/payment-info/{agentId}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Returns Payment info for an agent", | |
| "operationId": "getTransactionPaymentInfoForAgent", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionPaymentInfo" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/paid-at-closing": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get transaction's paid-at-closing status", | |
| "operationId": "getPaidAtClosingStatus", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionPaidAtClosingStatusResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/money-transfers": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get Transaction Money Transfers", | |
| "operationId": "getTransactionMoneyTransfers", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.MoneyTransferResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/is-display-agent-reported-transaction-closed-dialog": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get info whether the \"Has this Transaction Closed?\" modal dialog should be displayed or not", | |
| "operationId": "isDisplayAgentReportedTransactionClosedDialog", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentReportedTransactionClosedDialogResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/features": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Gets the features eligible to this transaction", | |
| "operationId": "getFeatures", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.FeaturesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/comment-participants/{agentId}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get all participants on the transaction comment", | |
| "operationId": "getTransactionCommentParticipants", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "includeTransactionParticipants", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": true | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionCommentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/checklist-assignees": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "get all possible checklist assignees on a given transaction", | |
| "operationId": "getPossibleChecklistAssignees", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentPublicInfosResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/check-permissions": { | |
| "get": { | |
| "tags": [ | |
| "check-permissions-controller" | |
| ], | |
| "operationId": "checkPermissionForTransaction", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/check-deposits": { | |
| "get": { | |
| "tags": [ | |
| "check-deposits-controller" | |
| ], | |
| "summary": "Get transaction check deposits", | |
| "operationId": "getTransactionCheckDeposits", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.CheckDepositDto" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/check-deposits/{depositType}/upload-link": { | |
| "get": { | |
| "tags": [ | |
| "external-check-deposits-controller" | |
| ], | |
| "summary": "Get external deposit link", | |
| "operationId": "getExternalDepositLink", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "depositType", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "COMMISSION", | |
| "TRUST" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/check-deposits/{checkDepositId}/front-image/download-url": { | |
| "get": { | |
| "tags": [ | |
| "check-deposits-controller" | |
| ], | |
| "summary": "Get URL for check deposit front image download", | |
| "operationId": "getCheckFrontImageUrl", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "checkDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "modifiedImage", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/check-deposits/{checkDepositId}/back-image/download-url": { | |
| "get": { | |
| "tags": [ | |
| "check-deposits-controller" | |
| ], | |
| "summary": "Get URL for check deposit back image download", | |
| "operationId": "getCheckBackImageUrl", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "checkDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "modifiedImage", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/canada-bank-accounts": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get Transaction Canada Bank Accounts", | |
| "operationId": "getCanadianBankAccounts", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.BankAccountDto" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/bank-accounts": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get bank accounts", | |
| "operationId": "getBankAccounts", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.BankAccountDto" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/agent-participants": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "get agent participants on a given transaction", | |
| "operationId": "getAgentParticipants", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionAgentParticipantsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/rolling": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get Agents' Rolling Transaction Info", | |
| "operationId": "getRollingTransactionInfo", | |
| "parameters": [ | |
| { | |
| "name": "agentIds", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "rollingDays", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentsRollingTransactionInfoResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/participant/{yentaId}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "get all transactions by month (createdAt), no month = current month", | |
| "operationId": "getAllTransactionsByMonth", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "month", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "current" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionsMonthlyResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/participant/{yentaId}/transactions/{lifecycleGroup}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "get all transactions for a given user and state group with pagination", | |
| "operationId": "getTransactionsByStateGroupPaginated", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "lifecycleGroup", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "OPEN", | |
| "LISTING_ACTIVE", | |
| "CLOSED", | |
| "TERMINATED", | |
| "LISTING_NONTERMINATED" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ESCROW_CLOSING_DATE", | |
| "ACTUAL_CLOSING_DATE", | |
| "PRICE", | |
| "CREATED_AT", | |
| "UPDATED_AT", | |
| "EXPIRATION_DATE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "transactionType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "COMPENSATING", | |
| "REFERRAL", | |
| "SALE", | |
| "LEASE", | |
| "COMMERCIAL_LEASE", | |
| "PLOT", | |
| "OTHER", | |
| "INTERNAL_REFERRAL" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "officeId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "createdAtFrom", | |
| "in": "query", | |
| "description": "start date for createdAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-01" | |
| }, | |
| { | |
| "name": "createdAtTo", | |
| "in": "query", | |
| "description": "end date for createdAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-31" | |
| }, | |
| { | |
| "name": "updatedAtFrom", | |
| "in": "query", | |
| "description": "start date for updatedAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-01" | |
| }, | |
| { | |
| "name": "updatedAtTo", | |
| "in": "query", | |
| "description": "end date for updatedAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-31" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.PagedTransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/participant/{yentaId}/transactions/lifecycle-group-counts": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Count all transactions grouped by lifecyle group for a given user", | |
| "operationId": "getTransactionCountsByLifecycleGroup", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "default response", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionLifecycleCountsResponse" | |
| }, | |
| "example": { | |
| "countsByLifecycleGroup": { | |
| "CLOSED": 0, | |
| "OPEN": 1, | |
| "TERMINATED": 2 | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/participant/{yentaId}/listing-transactions/{lifecycleGroup}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "get all listing transactions for a given user and state group with pagination", | |
| "operationId": "getListingTransactionsByStateGroupPaginated", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "lifecycleGroup", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "OPEN", | |
| "LISTING_ACTIVE", | |
| "CLOSED", | |
| "TERMINATED", | |
| "LISTING_NONTERMINATED" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ESCROW_CLOSING_DATE", | |
| "ACTUAL_CLOSING_DATE", | |
| "PRICE", | |
| "CREATED_AT", | |
| "UPDATED_AT", | |
| "EXPIRATION_DATE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "transactionType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "COMPENSATING", | |
| "REFERRAL", | |
| "SALE", | |
| "LEASE", | |
| "COMMERCIAL_LEASE", | |
| "PLOT", | |
| "OTHER", | |
| "INTERNAL_REFERRAL" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "officeId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "createdAtFrom", | |
| "in": "query", | |
| "description": "start date for createdAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-01" | |
| }, | |
| { | |
| "name": "createdAtTo", | |
| "in": "query", | |
| "description": "end date for createdAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-31" | |
| }, | |
| { | |
| "name": "updatedAtFrom", | |
| "in": "query", | |
| "description": "start date for updatedAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-01" | |
| }, | |
| { | |
| "name": "updatedAtTo", | |
| "in": "query", | |
| "description": "end date for updatedAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-31" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.PagedTransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/participant/{yentaId}/listing-transactions/lifecycle-group-counts": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Count all listings grouped by lifecyle group for a given user", | |
| "operationId": "getListingCountsByLifecycleGroup", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "default": { | |
| "description": "default response", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionLifecycleCountsResponse" | |
| }, | |
| "example": { | |
| "countsByLifecycleGroup": { | |
| "CLOSED": 0, | |
| "OPEN": 1, | |
| "TERMINATED": 2 | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/participant/{yentaId}/current": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "get current transactions", | |
| "operationId": "getCurrentTransactions", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionsOverviewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/escrows/{escrowId}/escrow-deposit/{escrowDepositId}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get escrow deposit by id)", | |
| "operationId": "getEscrowDeposit", | |
| "parameters": [ | |
| { | |
| "name": "escrowId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "escrowDepositId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EscrowDepositResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/code/{transactionCode}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "Get Transaction by code", | |
| "operationId": "getTransactionByCode", | |
| "parameters": [ | |
| { | |
| "name": "transactionCode", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{tbId}/metadata-for-participant-creation/{participantRole}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Metadata required to create a participant", | |
| "operationId": "getCreateParticipantMetadata_1", | |
| "parameters": [ | |
| { | |
| "name": "tbId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "participantRole", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "REAL", | |
| "BUYERS_AGENT", | |
| "TENANT_AGENT", | |
| "REFERRING_AGENT", | |
| "SELLERS_AGENT", | |
| "OTHER_AGENT", | |
| "EXTERNAL_AGENT", | |
| "TEAM_LEADER", | |
| "TEAM_MEMBER", | |
| "DOMESTIC_LEAD", | |
| "TRANSACTION_COORDINATOR", | |
| "ADMIN", | |
| "INSPECTION", | |
| "ESCROW", | |
| "TITLE", | |
| "LANDLORD", | |
| "MANAGEMENT_COMPANY", | |
| "ATTORNEY", | |
| "APPRAISER", | |
| "HOME_WARRANTY", | |
| "LENDER", | |
| "BUYER", | |
| "SELLER", | |
| "TENANT", | |
| "OTHER", | |
| "UNKNOWN", | |
| "REFERRAL_PAYER", | |
| "SELLERS_LAWYER", | |
| "BUYERS_LAWYER", | |
| "TRUSTEE", | |
| "REAL_ADMIN", | |
| "BUILDER", | |
| "PRO_TEAM_LEADER" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ParticipantCreationMetadataResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}": { | |
| "get": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Get transaction builder by id", | |
| "operationId": "getTransactionBuilder", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "delete transaction builder", | |
| "operationId": "deleteTransactionBuilder", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/features": { | |
| "get": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Gets the optional features available for the transaction being built", | |
| "operationId": "getFeatures_1", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.FeaturesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/eligible-for-mortgage-ecp": { | |
| "get": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Is the transaction owner eligible to opt in for early mortgage commission payment?", | |
| "operationId": "isEligibleToOptInForEarlyMortgageCommission", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EligibleForEarlyCommission" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/commission-payer-roles-and-display-name": { | |
| "get": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Get commission payer roles and display for given builderId", | |
| "operationId": "getCommissionPayerRolesAndDisplayName", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionPayerDisplayValue" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/paged": { | |
| "get": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Get a paginated list of transaction builders", | |
| "operationId": "getTransactionBuildersPaginated", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "from", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "yentaId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "TRANSACTION", | |
| "enum": [ | |
| "TRANSACTION", | |
| "LISTING" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "dealType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "COMPENSATING", | |
| "REFERRAL", | |
| "SALE", | |
| "LEASE", | |
| "COMMERCIAL_LEASE", | |
| "PLOT", | |
| "OTHER", | |
| "INTERNAL_REFERRAL" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.GenericSearchResponseTransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/commission-payer-roles": { | |
| "get": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Get commission payer roles for given country", | |
| "operationId": "getCommissionPayerRoles", | |
| "parameters": [ | |
| { | |
| "name": "country", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "UNITED_STATES", | |
| "CANADA" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "REAL", | |
| "BUYERS_AGENT", | |
| "TENANT_AGENT", | |
| "REFERRING_AGENT", | |
| "SELLERS_AGENT", | |
| "OTHER_AGENT", | |
| "EXTERNAL_AGENT", | |
| "TEAM_LEADER", | |
| "TEAM_MEMBER", | |
| "DOMESTIC_LEAD", | |
| "TRANSACTION_COORDINATOR", | |
| "ADMIN", | |
| "INSPECTION", | |
| "ESCROW", | |
| "TITLE", | |
| "LANDLORD", | |
| "MANAGEMENT_COMPANY", | |
| "ATTORNEY", | |
| "APPRAISER", | |
| "HOME_WARRANTY", | |
| "LENDER", | |
| "BUYER", | |
| "SELLER", | |
| "TENANT", | |
| "OTHER", | |
| "UNKNOWN", | |
| "REFERRAL_PAYER", | |
| "SELLERS_LAWYER", | |
| "BUYERS_LAWYER", | |
| "TRUSTEE", | |
| "REAL_ADMIN", | |
| "BUILDER", | |
| "PRO_TEAM_LEADER" | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/commission-payer-roles-and-display-name": { | |
| "get": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Get commission payer roles and display for given representation type", | |
| "operationId": "getCommissionPayerRolesAndDisplayName_1", | |
| "parameters": [ | |
| { | |
| "name": "representationType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "SELLER", | |
| "BUYER", | |
| "DUAL", | |
| "LANDLORD", | |
| "TENANT" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionPayerDisplayValue" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/tax-docs/{docId}/download-url": { | |
| "get": { | |
| "tags": [ | |
| "tax-document-controller" | |
| ], | |
| "summary": "Get URL for Tax Document download", | |
| "operationId": "getTaxDocumentUrl", | |
| "parameters": [ | |
| { | |
| "name": "docId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/tax-docs/{agentYentaId}": { | |
| "get": { | |
| "tags": [ | |
| "tax-document-controller" | |
| ], | |
| "summary": "Get tax docs for agent", | |
| "operationId": "getTaxDocumentsForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TaxDocumentListResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/tax-docs/{agentYentaId}/current": { | |
| "get": { | |
| "tags": [ | |
| "tax-document-controller" | |
| ], | |
| "summary": "Get the current year's tax document for an agent", | |
| "operationId": "calculateTaxDocumentForCurrentYear", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TaxDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/tax-docs/doc/{docId}": { | |
| "get": { | |
| "tags": [ | |
| "tax-document-controller" | |
| ], | |
| "summary": "Get a specific tax document", | |
| "operationId": "getTaxDocument", | |
| "parameters": [ | |
| { | |
| "name": "docId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TaxDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{yentaId}/payments": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Gets all revshare payments for a particular agent", | |
| "operationId": "getRevSharePaymentsForAgent", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevSharePaymentsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{yentaId}/payments/{outgoingPaymentId}": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Get details for a particular rev share payment", | |
| "operationId": "getRevSharePaymentsForAgent_1", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "outgoingPaymentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevSharePaymentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{yentaId}/payments/{outgoingPaymentId}/export": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Returns a CSV file for all revshare contributions in a given payment for a particular agent", | |
| "operationId": "getRevSharePaymentExportForAgent", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "outgoingPaymentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{yentaId}/payments/pending": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Gets all pending revshare payments for a particular agent", | |
| "operationId": "getPendingPaymentForAgent", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevSharePaymentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{yentaId}/payments/pending/export": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Returns a CSV file for all pending revshare payments for a particular agent", | |
| "operationId": "getPendingPaymentExportForAgent", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{yentaId}/payments/pending-overview": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Gets pending revshare payments overview for a particular agent", | |
| "operationId": "getPendingPaymentPreviewForAgent", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevSharePaymentPreviewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{yentaId}/contributors/{tier}": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Gets revshare contributors by tier", | |
| "operationId": "getContributorsByTier", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "tier", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevshareContributorsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{yentaId}/contributions/{tier}": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Gets agent wise revshare contributions by tier", | |
| "operationId": "getRevshareContributionsByTier", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "tier", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "missed", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevshareContributionsByTierResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{yentaId}/by-tier": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Gets revshare by tier for a particular agent", | |
| "operationId": "getRevshareByTier", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevshareByTierResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/{agentYentaId}/history": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "Get Agent's revshare History", | |
| "operationId": "getRevshareHistory", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "startDate", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "endDate", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevShareHistoryResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/performance/{yentaId}/revenue-share": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "gets the rev share performance for a particular month for an agent", | |
| "operationId": "getMonthlyPerformanceOverview", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "month", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "current" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevShareMonthlyResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/revshares/performance/{yentaId}/revenue-share/current": { | |
| "get": { | |
| "tags": [ | |
| "rev-share-controller" | |
| ], | |
| "summary": "gets the current rev share performance overview for an agent", | |
| "operationId": "getCurrentRevSharePerformanceOverview", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RevShareOverviewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/reports/{yentaId}/transactions/terminated": { | |
| "get": { | |
| "tags": [ | |
| "report-controller" | |
| ], | |
| "summary": "Get agent terminated transaction report", | |
| "operationId": "getAgentTerminatedTransactionReport", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "dateFrom", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "dateTo", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/reports/{yentaId}/transactions/open": { | |
| "get": { | |
| "tags": [ | |
| "report-controller" | |
| ], | |
| "summary": "Get agent open transaction report", | |
| "operationId": "getAgentOpenTransactionReport", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "dateFrom", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "dateTo", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/reports/{yentaId}/transactions/closed": { | |
| "get": { | |
| "tags": [ | |
| "report-controller" | |
| ], | |
| "summary": "Get agent closed transaction report", | |
| "operationId": "getAgentClosedTransactionReport", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "dateFrom", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "dateTo", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/reports/{yentaId}/revshare": { | |
| "get": { | |
| "tags": [ | |
| "report-controller" | |
| ], | |
| "summary": "Get agent revenue share payment report", | |
| "operationId": "getAgentRevenueSharePaymentsReport", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "dateFrom", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "dateTo", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/refunds/{refundId}": { | |
| "get": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Get Refund By Id", | |
| "operationId": "getRefund", | |
| "parameters": [ | |
| { | |
| "name": "refundId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.RefundResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/refunds/{id}/attachments": { | |
| "get": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Get all attachment for refund", | |
| "operationId": "getAllAttachmentForRefund", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.RefundAttachmentResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/refunds/participants-for-tx/{transactionId}": { | |
| "get": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Get All Refund Participants for transaction", | |
| "operationId": "getParticipantsForTransaction", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.ParticipantResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/refunds/attachment/{attachmentId}": { | |
| "get": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Get URL for refund attachment", | |
| "operationId": "getAttachmentURl", | |
| "parameters": [ | |
| { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Deletes an attachment for refund", | |
| "operationId": "deleteAttachment", | |
| "parameters": [ | |
| { | |
| "name": "attachmentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/outgoing-payments/transaction/{transactionId}": { | |
| "get": { | |
| "tags": [ | |
| "outgoing-payments-controller" | |
| ], | |
| "summary": "Get outgoing payments for transaction", | |
| "operationId": "getOutgoingPaymentsForTransaction", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.OutgoingPaymentWithBankInfoListResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/outgoing-payments/search/all": { | |
| "get": { | |
| "tags": [ | |
| "outgoing-payments-controller" | |
| ], | |
| "summary": "Search outgoing payments", | |
| "operationId": "searchOutgoingPayments", | |
| "parameters": [ | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "COMPANY", | |
| "TRANSACTION_CODE", | |
| "PAYMENT_SYSTEM_ID", | |
| "CONFIRMATION_CODE", | |
| "FIRST_NAME", | |
| "LAST_NAME", | |
| "TRANSACTION_ADDRESS", | |
| "PAID_AT", | |
| "PAID_ON", | |
| "AMOUNT", | |
| "PAYMENT_SYSTEM", | |
| "STATUS" | |
| ] | |
| }, | |
| "default": [ | |
| "FIRST_NAME" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "ASC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "company", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| } | |
| }, | |
| { | |
| "name": "transactionCode", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| } | |
| }, | |
| { | |
| "name": "paymentSystemId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| } | |
| }, | |
| { | |
| "name": "confirmationCode", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| } | |
| }, | |
| { | |
| "name": "firstName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| } | |
| }, | |
| { | |
| "name": "lastName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| } | |
| }, | |
| { | |
| "name": "transactionAddress", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| } | |
| }, | |
| { | |
| "name": "paidAt", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| { | |
| "name": "paidAtGreaterThanOrEqualTo", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "paidAtLessThanOrEqualTo", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "paidOn", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "paidOnGreaterThanOrEqualTo", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "paidOnLessThanOrEqualTo", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "createdAt", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| { | |
| "name": "createdAfter", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| { | |
| "name": "createdBefore", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| }, | |
| { | |
| "name": "amount", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| } | |
| }, | |
| { | |
| "name": "amountGreaterThanOrEqualTo", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| } | |
| }, | |
| { | |
| "name": "amountLessThanOrEqualTo", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "number" | |
| } | |
| }, | |
| { | |
| "name": "currency", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "USD", | |
| "CAD" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "paymentSystem", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "TIPALTI", | |
| "MICROSOFT_DYNAMICS", | |
| "MICROSOFT_DYNAMICS_PAYMENT_JOURNAL", | |
| "WALLET", | |
| "NETSUITE" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "PENDING_APPROVAL", | |
| "INITIATED", | |
| "OPEN", | |
| "APPROVED", | |
| "GENERAL_ERROR", | |
| "SCHEDULING_ERROR", | |
| "WALLET_SCHEDULING_ERROR", | |
| "SENT_TO_PAYMENT_SYSTEM", | |
| "SCHEDULED_FOR_PAYMENT", | |
| "PAID", | |
| "PENDING", | |
| "REJECTED", | |
| "DELETED", | |
| "DISPUTED", | |
| "CANCELLED", | |
| "INVALID_PAYMENT_DETAILS" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "officeId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "default": [] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.GenericSearchResponseSearchOutgoingPaymentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/invoices/{invoiceId}": { | |
| "get": { | |
| "tags": [ | |
| "invoice-controller" | |
| ], | |
| "summary": "Get Outgoing Payment", | |
| "operationId": "getInvoice", | |
| "parameters": [ | |
| { | |
| "name": "invoiceId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.InvoiceResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/instant-payment/{instantPaymentId}": { | |
| "get": { | |
| "tags": [ | |
| "instant-payment-controller" | |
| ], | |
| "summary": "Get instant payment", | |
| "operationId": "getInstantPayment", | |
| "parameters": [ | |
| { | |
| "name": "instantPaymentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.InstantPaymentDetailResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/instant-payment/agent/{agentId}": { | |
| "get": { | |
| "tags": [ | |
| "instant-payment-controller" | |
| ], | |
| "summary": "Get agent's instant payments", | |
| "operationId": "getInstantPaymentSummary", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.InstantPaymentsSummary" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/instant-payment/agent/{agentId}/eligible-instant-payment/{transactionId}": { | |
| "get": { | |
| "tags": [ | |
| "instant-payment-controller" | |
| ], | |
| "summary": "Get eligible instant payment parameters for transaction", | |
| "operationId": "getEligibleInstantPayment", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.InstantPaymentTransactionSummaryDetailResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/income/overview/{yentaId}": { | |
| "get": { | |
| "tags": [ | |
| "income-controller" | |
| ], | |
| "summary": "get the monthly income for a given month", | |
| "operationId": "getMonthlyIncomePerformance", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "month", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "current" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.IncomeMonthlyResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/income/overview/{yentaId}/total": { | |
| "get": { | |
| "tags": [ | |
| "income-controller" | |
| ], | |
| "summary": "get income totals for the anniversary year", | |
| "operationId": "getIncomeTotals", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.IncomeTotalsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/income/overview/{yentaId}/current": { | |
| "get": { | |
| "tags": [ | |
| "income-controller" | |
| ], | |
| "summary": "gets the current yearly income performance overview for an agent", | |
| "operationId": "getYearlyIncomePerformanceOverview", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.IncomeOverviewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/income/overview/{yentaId}/all": { | |
| "get": { | |
| "tags": [ | |
| "income-controller" | |
| ], | |
| "summary": "gets cumulative all-time income performance overview for an agent", | |
| "operationId": "getAllTimeIncomePerformanceOverview", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.IncomeMonthlyResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/equity/share-counts/{yentaId}/all": { | |
| "get": { | |
| "tags": [ | |
| "equity-controller" | |
| ], | |
| "summary": "gets the current equity share counts for an agent", | |
| "operationId": "getEquityShareCounts", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EquityShareCountsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/equity/performance/{yentaId}": { | |
| "get": { | |
| "tags": [ | |
| "equity-controller" | |
| ], | |
| "summary": "gets the equity contributions over transactions for a particular month for an agent", | |
| "operationId": "getMonthlyPerformanceOverview_1", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "month", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "current" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EquityMonthlyResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/equity/performance/{yentaId}/current": { | |
| "get": { | |
| "tags": [ | |
| "equity-controller" | |
| ], | |
| "summary": "gets the current equity contributions overview for an agent", | |
| "operationId": "getCurrentRevSharePerformanceOverview_1", | |
| "parameters": [ | |
| { | |
| "name": "yentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.EquityOverviewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/conveyance/{transactionId}/download-url": { | |
| "get": { | |
| "tags": [ | |
| "conveyance-controller" | |
| ], | |
| "summary": "Get URLs for conveyances given transaction Id", | |
| "operationId": "getPreSignedUrl", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.ConveyanceDocumentPdfUrlResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/conveyance/{conveyanceId}": { | |
| "get": { | |
| "tags": [ | |
| "conveyance-controller" | |
| ], | |
| "summary": "Get Conveyance by Id", | |
| "operationId": "getById", | |
| "parameters": [ | |
| { | |
| "name": "conveyanceId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ConveyanceResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/conveyance/transaction/{transactionId}": { | |
| "get": { | |
| "tags": [ | |
| "conveyance-controller" | |
| ], | |
| "summary": "Get Conveyances by Transaction id", | |
| "operationId": "getByTransaction", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.ConveyanceLetterRevisionResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/commission-advances/{commissionAdvanceId}/download-url": { | |
| "get": { | |
| "tags": [ | |
| "commission-advances-controller" | |
| ], | |
| "summary": "Get URL for download", | |
| "operationId": "getPreSignedUrl_1", | |
| "parameters": [ | |
| { | |
| "name": "commissionAdvanceId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cdas/{transactionId}/get-approved-commission-document-by-transaction-id": { | |
| "get": { | |
| "tags": [ | |
| "commission-document-controller" | |
| ], | |
| "summary": "Get commission document by transaction id", | |
| "operationId": "getCommissionDocumentByTransactionId", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cdas/{transactionId}/get-all-commission-documents-by-transaction-id": { | |
| "get": { | |
| "tags": [ | |
| "commission-document-controller" | |
| ], | |
| "summary": "Get all commission documents by transaction id", | |
| "operationId": "getAllCommissionDocumentsByTransactionId", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cdas/{transactionId}/generate-cda-pdf": { | |
| "get": { | |
| "tags": [ | |
| "commission-document-controller" | |
| ], | |
| "summary": "Generate CDA PDF for a transaction", | |
| "operationId": "generateCdaPdf", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cdas/{id}": { | |
| "get": { | |
| "tags": [ | |
| "commission-document-controller" | |
| ], | |
| "summary": "Get commission document by id", | |
| "operationId": "getCommissionDocumentById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionDocumentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cdas/{id}/payout-explanation": { | |
| "get": { | |
| "tags": [ | |
| "commission-document-controller" | |
| ], | |
| "summary": "Get transaction payout explanation associated with commission document by id", | |
| "operationId": "getPayoutExplanationForCommissionDocumentById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CDAPayoutExplanationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cdas/{commissionDocumentId}/download-url": { | |
| "get": { | |
| "tags": [ | |
| "commission-document-controller" | |
| ], | |
| "summary": "Get URL for download", | |
| "operationId": "getPreSignedUrl_2", | |
| "parameters": [ | |
| { | |
| "name": "commissionDocumentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cdas/trade-record-sheet-download-url/{s3Path}": { | |
| "get": { | |
| "tags": [ | |
| "commission-document-controller" | |
| ], | |
| "summary": "Get URL for download for trade record sheet payment participant view", | |
| "operationId": "getPdfUrlForTradeRecordSheet", | |
| "parameters": [ | |
| { | |
| "name": "s3Path", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/awards/performance/{agentId}/all": { | |
| "get": { | |
| "tags": [ | |
| "award-controller" | |
| ], | |
| "summary": "return the capping, attracting, and cultural award share counts awarded to the agent", | |
| "operationId": "getAwardShareCounts", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AwardPerformanceResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{id}/front-line": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent's front line", | |
| "operationId": "getAgentFrontLine", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.FrontLineAgentsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentYentaId}": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent", | |
| "operationId": "getAgentByYentaId", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentYentaId}/referrals": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update referral attachment", | |
| "operationId": "getReferrals", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.ReferralsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentYentaId}/lite": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent lite", | |
| "operationId": "getAgentLite", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentLiteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentYentaId}/commission-advances": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get Agent's Commission Advances", | |
| "operationId": "getCommissionAdvances", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionAdvanceListResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentYentaId}/commission-advances-paged": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get Agent's Commission Advances", | |
| "operationId": "getCommissionAdvances_1", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "AGREEMENT_RECEIVED", | |
| "APPROVED", | |
| "REJECTED", | |
| "REPAID", | |
| "PARTIALLY_REPAID", | |
| "UNLINKED" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "AMOUNT", | |
| "COMPANY_NAME", | |
| "REFERENCE_NUMBER", | |
| "STATUS", | |
| "CREATED_AT", | |
| "UPDATED_AT" | |
| ] | |
| }, | |
| "default": [ | |
| "REFERENCE_NUMBER" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "ASC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.CommissionAdvanceListPagedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentYentaId}/cap-info": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent's cap info", | |
| "operationId": "getAgentCapInfo", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentCapInfoResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/{agentId}/financial-results": { | |
| "get": { | |
| "tags": [ | |
| "agent-stats-controller" | |
| ], | |
| "summary": "Get agent's financial results", | |
| "operationId": "getAgentFinancialResultReport", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "report", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "GCI", | |
| "CLOSED_TRANSACTIONS", | |
| "REV_SHARE_RECEIVED", | |
| "SPP_CONTRIBUTION", | |
| "VOLUME", | |
| "SCALED_VOLUME" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentFinancialReportResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/team/{teamId}/cap-info": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get team's cap info", | |
| "operationId": "getAgentTeamCapInfo", | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.AgentTeamCapInfoResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/agent/referral/{referralId}/download-url": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get URL for download", | |
| "operationId": "getPreSignedUrl_3", | |
| "parameters": [ | |
| { | |
| "name": "referralId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transactions/{transactionId}/participant/{participantId}/payment": { | |
| "delete": { | |
| "tags": [ | |
| "transaction-controller" | |
| ], | |
| "summary": "remove participant payment", | |
| "operationId": "removePayment", | |
| "parameters": [ | |
| { | |
| "name": "transactionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/seller/{sellerId}": { | |
| "delete": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Delete a seller", | |
| "operationId": "deleteSeller", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "sellerId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/referral-info/{participantId}": { | |
| "delete": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Delete referral info", | |
| "operationId": "deleteReferralInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/other-participants/{participantId}": { | |
| "delete": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Delete other participant from the transaction builder", | |
| "operationId": "deleteParticipant", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "participantId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/co-agent/{coAgentId}": { | |
| "delete": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "Delete a co-agent by coAgentId", | |
| "operationId": "deleteCoAgent", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "coAgentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/transaction-builder/{id}/buyer/{buyerId}": { | |
| "delete": { | |
| "tags": [ | |
| "transaction-builder-controller" | |
| ], | |
| "summary": "delete a buyer", | |
| "operationId": "deleteBuyer", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "buyerId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Arrakis.TransactionBuilderResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/refunds/{id}/cancel-by-agent": { | |
| "delete": { | |
| "tags": [ | |
| "refund-controller" | |
| ], | |
| "summary": "Agent Cancels a refund", | |
| "operationId": "agentCancelRefund", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://arrakis.therealbrokerage.com/api/v1/cache/{agentYentaId}": { | |
| "delete": { | |
| "tags": [ | |
| "cache-controller" | |
| ], | |
| "summary": "Flush agent cache", | |
| "operationId": "flushAgentCache", | |
| "parameters": [ | |
| { | |
| "name": "agentYentaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v2/users/{id}/profile": { | |
| "get": { | |
| "tags": [ | |
| "user-profile-controller" | |
| ], | |
| "summary": "Get user profile by id", | |
| "operationId": "getProfileByUserId", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserProfileResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "user-profile-controller" | |
| ], | |
| "summary": "Update user profile by id", | |
| "operationId": "updateUserProfileById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserProfileUpdateRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserProfileResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/website/{websiteId}": { | |
| "put": { | |
| "tags": [ | |
| "agent-website-controller" | |
| ], | |
| "summary": "Update agent website by id", | |
| "operationId": "updateWebsiteById", | |
| "parameters": [ | |
| { | |
| "name": "websiteId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreateOrUpdateAgentWebsiteRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentWebsiteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/sign": { | |
| "put": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Sign the agreement", | |
| "operationId": "signAgreement", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementSigningRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementSigningResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/generate": { | |
| "put": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Generate an agreement", | |
| "operationId": "generateAgreement", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementCreationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementCreationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/teams/{id}": { | |
| "get": { | |
| "tags": [ | |
| "team-controller" | |
| ], | |
| "summary": "Get team by id", | |
| "operationId": "getTeamById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TeamResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/pushNotifications/{pushRegistrationId}": { | |
| "put": { | |
| "tags": [ | |
| "push-notification-controller" | |
| ], | |
| "summary": "Register a push notification token for a particular user", | |
| "operationId": "register", | |
| "parameters": [ | |
| { | |
| "name": "pushRegistrationId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "clientApplication", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "REZEN", | |
| "enum": [ | |
| "REZEN", | |
| "ONE_REAL" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.RegistrationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/mls/{id}": { | |
| "get": { | |
| "tags": [ | |
| "mls-controller" | |
| ], | |
| "summary": "Get MLS by id", | |
| "operationId": "getMlsById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.MlsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/companies/{id}": { | |
| "get": { | |
| "tags": [ | |
| "company-controller" | |
| ], | |
| "summary": "Get company by id", | |
| "operationId": "getCompanyById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CompanyResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/calendar/event/{calendarEventId}": { | |
| "get": { | |
| "tags": [ | |
| "calendar-controller" | |
| ], | |
| "summary": "Gets calendar event by id", | |
| "operationId": "getCalendarEvent", | |
| "parameters": [ | |
| { | |
| "name": "calendarEventId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CalendarEventResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/buyer-broker-agreements/generate": { | |
| "put": { | |
| "tags": [ | |
| "buyer-broker-agreement-controller" | |
| ], | |
| "summary": "Generate a Buyer broker agreement and send email to buyer", | |
| "operationId": "generateBuyerBrokerAgreement", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BuyerBrokerAgreementCreationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BuyerBrokerAgreementCreationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/boards/{id}": { | |
| "get": { | |
| "tags": [ | |
| "board-controller" | |
| ], | |
| "summary": "Get board by id", | |
| "operationId": "getBoardById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BoardResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/banners/{bannerId}/status": { | |
| "put": { | |
| "tags": [ | |
| "banner-controller" | |
| ], | |
| "summary": "Update banner status", | |
| "operationId": "updateBannerStatus", | |
| "parameters": [ | |
| { | |
| "name": "bannerId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UpdateBannerStatusRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/{id}": { | |
| "get": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Fetch an application by a given id", | |
| "operationId": "getApplication", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Update an existing application", | |
| "operationId": "updateApplication", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UpdateApplicationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/{id}/license/{stateOrProvince}/license-image": { | |
| "put": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Update an existing application license image", | |
| "operationId": "updateApplicationLicenseImage", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "stateOrProvince", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "licenseImage" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "licenseImage": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent by id", | |
| "operationId": "getAgentById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent by id", | |
| "operationId": "updateAgentById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/will-beneficiary-onboarding": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update if agent completed will beneficiary onboarding", | |
| "operationId": "updateNeedsWillBeneficiaryOnboarding", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateNeedsWillBeneficiaryOnboardingRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/tax-onboarding": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update if agent completed tax onboarding", | |
| "operationId": "updateNeedsTaxOnboarding", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateNeedsTaxOnboardingRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/paid-via-business-entity": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update if agent prefers to get paid via a business entity", | |
| "operationId": "updatePaidViaBusinessEntity", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BusinessEntityValue" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Set the agent to be paid as a personal entity, not a business entity.", | |
| "operationId": "clearPaidViaBusinessEntity", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/needs-website-onboarding": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's website onboarding flag to true", | |
| "operationId": "updateAgentNeedsWebsiteOnboarding", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateNeedsWebsiteOnboardingRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/national-identifications": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Set an agent's national identifications", | |
| "operationId": "getNationalIdentifications", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentNationalIdsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Set an agent's national identifications", | |
| "operationId": "setNationalIdentifications", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.SetNationalIdentificationsRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentNationalIdsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/mlses": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's MLSes by agent's id", | |
| "operationId": "updateAgentMlsesById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateMlsesRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/license/{licenseId}/signature-image": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Updates agent's signature image", | |
| "operationId": "updateAgentSignatureImage", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "licenseId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "imageFile" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "imageFile": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/license/{licenseId}/license-image": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Updates agent's license image", | |
| "operationId": "updateAgentLicenseImage", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "licenseId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "imageFile" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "imageFile": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/join-real-email": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's join real email", | |
| "operationId": "updateJoinRealEmail", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateJoinRealEmailRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/chime/request-unsubscribe": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Request unsubscribe to Chime", | |
| "operationId": "requestChimeUnsubscribe", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/chime/request-subscribe": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Request subscribe to Chime", | |
| "operationId": "requestChimeSubscribe", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/business-email": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent business email address", | |
| "operationId": "updateBusinessEmailAddress", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateBusinessEmailRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/boards": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's boards by agent's id", | |
| "operationId": "updateAgentBoardsById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateBoardsRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/will-beneficiary": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent's will beneficiary", | |
| "operationId": "getWillBeneficiaryForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WillBeneficiaryResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's individual will beneficiary", | |
| "operationId": "updateWillBeneficiaryForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UpdateWillBeneficiaryRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WillBeneficiaryResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Create agent's individual will beneficiary", | |
| "operationId": "createWillBeneficiaryForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreateWillBeneficiaryRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WillBeneficiaryResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/will-beneficiary-trust": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's will beneficiary trust", | |
| "operationId": "updateWillBeneficiaryTrustForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WillBeneficiaryTrustRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WillBeneficiaryTrustResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Create agent's will beneficiary trust", | |
| "operationId": "createWillBeneficiaryTrustForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WillBeneficiaryTrustRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WillBeneficiaryTrustResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/set-single-check-preference": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update single check preference for a given agent.", | |
| "operationId": "updateSingleCheckPreference", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UpdateAgentSingleCheckPreferenceRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/payment-methods/allocation": { | |
| "put": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Configure allocations of payments towards existing payment methods for a user", | |
| "operationId": "configurePaymentAllocations", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ConfigurePaymentAllocations" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BatchPaymentMethodsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/one-real-impact-fund": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's one real impact fund config", | |
| "operationId": "updateOneRealImpactFund", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.OneRealImpactFundConfigDto" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/needOnBoarding/{id}": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent licenseVerified by id", | |
| "operationId": "updateNeedOnBoarding", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateNeedOnBoardingRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/licensesBoardMls/{id}": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update Licenses/Board/MLS by id", | |
| "operationId": "updateAgentLicenseBoardMlsById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateLicenseBoardMlsRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/licenseVerified/{id}": { | |
| "put": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent licenseVerified by id", | |
| "operationId": "updateLicenseVerified", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateLicenseVerifiedRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/website/": { | |
| "post": { | |
| "tags": [ | |
| "agent-website-controller" | |
| ], | |
| "summary": "Create agent website by id or slug", | |
| "operationId": "createWebsiteForAgent", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreateOrUpdateAgentWebsiteRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentWebsiteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/{id}/avatar/upload": { | |
| "post": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Upload User Avatar", | |
| "operationId": "uploadAvatar", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "file" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "file": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApiResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/{id}/avatar/upload-provided": { | |
| "post": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Upload User Avatar exactly as provided", | |
| "operationId": "uploadAvatarProvided", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "file" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "file": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApiResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/forgotpassword": { | |
| "post": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "ForgotPassword", | |
| "operationId": "resetPassword", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ResetPasswordRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApiResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/for-public": { | |
| "post": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get public user info for a list of users, limited to no more than 20 user ids", | |
| "operationId": "getPublicUserInfos", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserIdsRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserPublicInfosResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/for-comment": { | |
| "post": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Returns the minimal user details needed to render a comment. Can request multiple keymaker ids, limited to no more than 20 ids", | |
| "operationId": "getUserDetailsForComment", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.KeymakerIdsRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.UserDetailsForComment" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/generate-willable-revshare": { | |
| "post": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Obtain a Willable Revshare agreement for the user to sign", | |
| "operationId": "generateAgreementForWillableRevshare", | |
| "parameters": [ | |
| { | |
| "name": "user", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WillBeneficiaryOnboardingRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/by-type": { | |
| "post": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Generate Agreement By Type", | |
| "operationId": "createAgreementByType", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/Yenta.CreateAgentReinstateAgreement" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.CreateAssistantAccessAgreement" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.CreateAssistantPolicyAndProceduresAgreement" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.CreateLicensedAssistantAddendumAgreement" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.CreateUnlicensedAssistantAddendumAgreement" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators": { | |
| "get": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Search Transaction Coordinators", | |
| "operationId": "searchTransactionCoordinators", | |
| "parameters": [ | |
| { | |
| "name": "searchTerm", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "stateOrProvinces", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "email", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 10 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "DESC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ID", | |
| "CREATED_AT" | |
| ] | |
| }, | |
| "default": [ | |
| "CREATED_AT" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "connectedWithAgentIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "permissions", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "NEW_TRANSACTION", | |
| "ALL_EXISTING_TRANSACTIONS", | |
| "EXISTING_TRANSACTION_IF_ADDED_AS_PARTICIPANT", | |
| "CREATE_TRANSACTION" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericSearchResponseTransactionCoordinatorSearchResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections/{connectionId}/resend": { | |
| "post": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Resend an email for a connection request", | |
| "operationId": "resendEmail", | |
| "parameters": [ | |
| { | |
| "name": "connectionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections/internal": { | |
| "post": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Create an internal transaction coordinator connection", | |
| "operationId": "createInternalTransactionCoordinatorConnection", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreateInternalTransactionCoordinatorConnectionRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TransactionCoordinatorConnectionViewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections/external": { | |
| "post": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Create an external transaction coordinator connection", | |
| "operationId": "createExternalTransactionCoordinatorConnection", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreateExternalTransactionCoordinatorConnectionRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TransactionCoordinatorConnectionViewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/teams/{teamId}/invitation": { | |
| "post": { | |
| "tags": [ | |
| "team-controller" | |
| ], | |
| "summary": "invite an agent to join a team", | |
| "operationId": "createTeamInvitation", | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreateTeamInvitationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TeamInvitationDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/teams/{teamId}/generic-link/generate": { | |
| "post": { | |
| "tags": [ | |
| "team-controller" | |
| ], | |
| "summary": "generate an generic invitation", | |
| "operationId": "generateGenericInvitation", | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreateGenericTeamInvitationRequestDto" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericTeamInvitationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/teams/invitations/redeem": { | |
| "post": { | |
| "tags": [ | |
| "team-controller" | |
| ], | |
| "summary": "redeem a team invitation for approved agent", | |
| "operationId": "redeemTeamInvitation", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.RedeemTeamInvitationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/teams/generic-link/redeem": { | |
| "post": { | |
| "tags": [ | |
| "team-controller" | |
| ], | |
| "summary": "redeem an generic invitation", | |
| "operationId": "redeemGenericInvitation", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.RedeemGenericTeamInvitationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/notes/batch-entity": { | |
| "post": { | |
| "tags": [ | |
| "note-controller" | |
| ], | |
| "summary": "Get Notes for a given entity Type by IDs", | |
| "operationId": "getNotesByIds", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.NoteBatchEntityRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.NotesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/flex-team": { | |
| "get": { | |
| "tags": [ | |
| "flex-team-controller" | |
| ], | |
| "summary": "Search flex teams", | |
| "operationId": "searchFlexTeams", | |
| "parameters": [ | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "ASC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ID", | |
| "NAME", | |
| "STATUS", | |
| "TEAM_TYPE", | |
| "LEADER_NAME", | |
| "CREATED_AT" | |
| ] | |
| }, | |
| "default": [ | |
| "NAME" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "teamType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "NORMAL", | |
| "PLATINUM", | |
| "DOMESTIC", | |
| "GROUP", | |
| "PRO" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "createdAtStart", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "createdAtEnd", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericSearchResponseSearchFlexTeamDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/vendors": { | |
| "post": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Create a vendor", | |
| "operationId": "createVendor", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryVendorCreateRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryVendorResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/persons": { | |
| "post": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Create a person", | |
| "operationId": "createPerson", | |
| "parameters": [ | |
| { | |
| "name": "ownerAgentId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "ownerTeamId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryPersonCreateRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryPersonResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/calendar/event/{calendarEventId}/agent/{agentId}/rsvp/{status}": { | |
| "post": { | |
| "tags": [ | |
| "calendar-controller" | |
| ], | |
| "summary": "Agent rvsps to calendar event", | |
| "operationId": "rsvpToCalendarEvent", | |
| "parameters": [ | |
| { | |
| "name": "calendarEventId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "status", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "YES", | |
| "NO", | |
| "MAYBE" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CalendarEventResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/buyer-broker-agreements/resend-email": { | |
| "post": { | |
| "tags": [ | |
| "buyer-broker-agreement-controller" | |
| ], | |
| "summary": "Resend email to buyer for signing buyer broker agreement", | |
| "operationId": "resendBuyerBrokerAgreement", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BuyerBrokerAgreementEmailResendRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications": { | |
| "post": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Create an application for the logged in user id", | |
| "operationId": "createApplication", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreateApplicationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/sign_ica": { | |
| "post": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Sign ICA", | |
| "operationId": "signICA", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ICASignRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/sign-loi": { | |
| "post": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Sign Letter of Intent", | |
| "operationId": "signLetterOfIntent", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.LetterOfIntentSignRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/sign-ica-agreement": { | |
| "post": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Sign ICA using agreement", | |
| "operationId": "signICAUsingAgreement", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationSigningRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/pay_fees": { | |
| "post": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Pay fees for application", | |
| "operationId": "payApplicationFees", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.FeePaymentRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/license_transferred": { | |
| "post": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Agent license is transferred", | |
| "operationId": "licenseTransferred", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.LicenseTransferRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/board_joined": { | |
| "post": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Agent joined the board", | |
| "operationId": "boardJoined", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BoardJoinedRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/apply": { | |
| "post": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Apply to be Real Agent", | |
| "operationId": "applyToReal", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/apply-real": { | |
| "post": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Apply to be a REAL Agent", | |
| "operationId": "applyAsRealAgent", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplyToRealRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/licenses": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's licenses by agent's id", | |
| "operationId": "updateAgentLicensesById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "licenses" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "licenses": { | |
| "$ref": "#/components/schemas/Yenta.AgentUpdateLicenseBoardMlsRequest" | |
| }, | |
| "licenseImage": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/license": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Creates agent's license", | |
| "operationId": "createAgentLicense", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "license" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "license": { | |
| "$ref": "#/components/schemas/Yenta.LicenseRequest" | |
| }, | |
| "licenseImage": { | |
| "type": "string", | |
| "format": "binary" | |
| }, | |
| "signatureImage": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/license/{licenseId}": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's license by id", | |
| "operationId": "updateAgentLicenseById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "licenseId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "license" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "license": { | |
| "$ref": "#/components/schemas/Yenta.LicenseRequest" | |
| }, | |
| "licenseImage": { | |
| "type": "string", | |
| "format": "binary" | |
| }, | |
| "signatureImage": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Delete agent's license by id", | |
| "operationId": "deleteAgentLicenseById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "licenseId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/license/{licenseId}/details": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update agent's license details by id", | |
| "operationId": "updateAgentLicenseDetailsById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "licenseId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.LicenseRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/divisions": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent designation division", | |
| "operationId": "getAgentDesignationDivision", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DivisionResponseWrapper" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/verify-license": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Verify agent's license", | |
| "operationId": "verifyLicense", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "licenseNumber", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "licenseImage" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "licenseImage": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentLicenseVerificationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/tax-forms": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get all tax forms for a given user", | |
| "operationId": "getTaxForms", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TaxFormsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Create a new tax form for a given user", | |
| "operationId": "createTaxForm", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "paymentSettingsId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/Yenta.CreateTaxFormCanada" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.CreateTaxFormW8BEN" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.CreateTaxFormW8ECI" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.CreateTaxFormW9" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/Yenta.TaxFormCanadaResponse" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.TaxFormLegacyResponse" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.TaxFormW8BENResponse" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.TaxFormW8ECIResponse" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.TaxFormW9Response" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/tax-forms/{taxFormId}/acknowledgement": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Check if tax form acknowledgment is required for an agent", | |
| "operationId": "getTaxFormAcknowledgement", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "taxFormId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TaxFormAcknowledgementResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Acknowledge the agent's tax form for the current tax year", | |
| "operationId": "acknowledgeTaxForm", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "taxFormId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/payment-methods": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get all payment methods for a given user", | |
| "operationId": "getPaymentMethods", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PaymentMethodsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Create a new payment method for a given user", | |
| "operationId": "createPaymentMethod", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreatePaymentMethod" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreatePaymentMethodResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/payment-methods-batch": { | |
| "post": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Create many new payment methods for a given user", | |
| "operationId": "batchCreatePaymentMethods", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BatchCreatePaymentMethods" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BatchPaymentMethodsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/onboard-to-payment-system": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Onboards a given user to the external payment system", | |
| "operationId": "onboardToPaymentSystem", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/learnworlds/sso": { | |
| "post": { | |
| "tags": [ | |
| "learnworlds-controller" | |
| ], | |
| "summary": "Fetches a token to login to Learnworlds using SSO.", | |
| "operationId": "signInToLearnworlds", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.LearnworldsSsoRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.LearnworldsSsoResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/allocated-payment-methods": { | |
| "post": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Create multiple payment methods for a user and allocate them to various purposes", | |
| "operationId": "createAllocatedPaymentMethods", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CreateAllocatedPaymentMethods" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BatchPaymentMethodsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/getPublicAgentInfos": { | |
| "post": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get public agent info for a list of agents, limited to no more than 100 agent IDs", | |
| "operationId": "getPublicAgentInfos", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentInfosRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentPublicInfosResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/{id}": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get user by id", | |
| "operationId": "getUserById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Patch user attributes", | |
| "operationId": "patchUser", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserPatchRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/{id}/amendments/{amendmentId}/sign": { | |
| "patch": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Sign an agreement amendment", | |
| "operationId": "signAgreementAmendment", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "amendmentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementAmendmentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/sign-willable-revshare": { | |
| "patch": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Notify the back-end that the given user signed their Willable Revshare agreement", | |
| "operationId": "willableRevshareAgreementSigned", | |
| "parameters": [ | |
| { | |
| "name": "user", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections/{connectionId}/revoke": { | |
| "patch": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Revoke a Connection Request", | |
| "operationId": "revokeConnectionRequest", | |
| "parameters": [ | |
| { | |
| "name": "connectionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections/{connectionId}/remove": { | |
| "patch": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Remove a Connection Request", | |
| "operationId": "removeConnection", | |
| "parameters": [ | |
| { | |
| "name": "connectionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.RemoveTransactionCoordinatorConnectionRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections/{connectionId}/reject": { | |
| "patch": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Reject an Connection Request", | |
| "operationId": "rejectConnectionRequest", | |
| "parameters": [ | |
| { | |
| "name": "connectionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections/{connectionId}/approve": { | |
| "patch": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Approve an Connection Request", | |
| "operationId": "approveConnectionRequest", | |
| "parameters": [ | |
| { | |
| "name": "connectionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections/{connectionId}/access": { | |
| "patch": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Update Transaction Coordinator Connection Access Type", | |
| "operationId": "updateAccess", | |
| "parameters": [ | |
| { | |
| "name": "connectionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UpdateTransactionCoordinatorConnectionAccessRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/teams/invitation/{invitationId}": { | |
| "patch": { | |
| "tags": [ | |
| "team-controller" | |
| ], | |
| "summary": "update an invitation", | |
| "operationId": "updateTeamInvitation", | |
| "parameters": [ | |
| { | |
| "name": "invitationId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PatchTeamInvitationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TeamInvitationDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/{id}": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get Office by id", | |
| "operationId": "getOfficeById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.OfficeResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/flex-team/{teamId}/members/{memberId}": { | |
| "patch": { | |
| "tags": [ | |
| "flex-team-controller" | |
| ], | |
| "summary": "Update flex team member by id", | |
| "operationId": "updateFlexTeamMember", | |
| "parameters": [ | |
| { | |
| "name": "teamId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "memberId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/Yenta.UpdateFlexTeamLeader" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/Yenta.UpdateFlexTeammate" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/flex-team/{id}": { | |
| "get": { | |
| "tags": [ | |
| "flex-team-controller" | |
| ], | |
| "summary": "Get flex team by Id", | |
| "operationId": "getFlexTeamById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.FlexTeamDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "flex-team-controller" | |
| ], | |
| "summary": "Update flex team by Id", | |
| "operationId": "updateFlexTeam", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UpdateFlexTeam" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/flex-team-config/{id}": { | |
| "get": { | |
| "tags": [ | |
| "flex-team-config-controller" | |
| ], | |
| "summary": "Get flex team configuration by Id", | |
| "operationId": "getFlexTeamConfigById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.FlexTeamConfigDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/vendors/{id}": { | |
| "get": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Get vendor by id", | |
| "operationId": "getVendorById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryVendorResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Update vendor by id", | |
| "operationId": "updateVendor", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryVendorUpdateRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryVendorResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/vendors/{id}/w9": { | |
| "get": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Get a vendor's w9 url", | |
| "operationId": "getVendorW9Path", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Update a vendor's w9 file", | |
| "operationId": "updateVendorW9", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "w9" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "w9": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryVendorResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/vendors/{id}/archive": { | |
| "patch": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Archive or unarchive a vendor", | |
| "operationId": "archiveVendor", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "archive", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": true | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryVendorResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/persons/{id}": { | |
| "get": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Get person by id", | |
| "operationId": "getPerson", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryPersonResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Update person by id", | |
| "operationId": "updatePerson", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryPersonUpdateRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryPersonResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/persons/{id}/unlink": { | |
| "patch": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Unlink a person from its linked vendor", | |
| "operationId": "unlinkPerson", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryPersonResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/persons/{id}/link": { | |
| "patch": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Link a person to a vendor", | |
| "operationId": "linkPerson", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryPersonLinkRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryPersonResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/persons/{id}/archive": { | |
| "patch": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Archive or unarchive a person", | |
| "operationId": "archivePerson", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "archive", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": true | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryPersonResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/{id}/driver-license-image": { | |
| "get": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Gets application driver license image", | |
| "operationId": "getApplicationDriverLicenseImage", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationDriverLicenseImageResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Updates application driver license image", | |
| "operationId": "updateApplicationDriverLicenseImage", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "driverLicenseImage" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "driverLicenseImage": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/update-zipcode": { | |
| "patch": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Update zipcode of agent by id", | |
| "operationId": "updateAgentZipCodeById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentZipCodeUpdateRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentZipCodeUpdateResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/driver-license-image": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Gets agent's driver license image", | |
| "operationId": "getAgentDriverLicenseImage", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentDriverLicenseImageResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Updates agent's driver license image", | |
| "operationId": "updateAgentDriverLicenseImage", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "required": [ | |
| "driverLicenseImage" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "driverLicenseImage": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/tax-forms/{taxFormId}": { | |
| "delete": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Archive a tax form by Id for a given user", | |
| "operationId": "archiveTaxForm", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "taxFormId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/payment-methods/{methodId}": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get payment method by ID for a given user", | |
| "operationId": "getPaymentMethod", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "methodId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PaymentMethodResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Archive a payment method by Id for a given user", | |
| "operationId": "archivePaymentMethod_1", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "methodId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Patch a payment method by Id for a given user", | |
| "operationId": "patchPaymentMethod", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "methodId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UpdatePaymentMethod" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PaymentMethodResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v2/users": { | |
| "get": { | |
| "tags": [ | |
| "user-profile-controller" | |
| ], | |
| "summary": "Search all users", | |
| "operationId": "searchUsers", | |
| "parameters": [ | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "ASC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ID", | |
| "FIRST_NAME", | |
| "LAST_NAME", | |
| "DISPLAY_NAME", | |
| "EMAIL_ADDRESS", | |
| "STATUS", | |
| "ANNIVERSARY_DATE", | |
| "CREATED_AT", | |
| "ACCOUNT_COUNTRY" | |
| ] | |
| }, | |
| "default": [ | |
| "LAST_NAME" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "firstName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "lastName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "displayName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "email", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "phoneNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "leoPhone", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "nonReportable", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "CANDIDATE", | |
| "ACTIVE", | |
| "INACTIVE", | |
| "REJECTED", | |
| "RESURRECTING" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "country", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "UNITED_STATES", | |
| "CANADA" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "stateOrProvince", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "officeId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "mlsId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "boardId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "divisionIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "roles", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "AGENT", | |
| "TRANSACTION_COORDINATOR" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericSearchResponseUserProfileResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/workvivo/{agentId}/jwt": { | |
| "get": { | |
| "tags": [ | |
| "workvivo-controller" | |
| ], | |
| "summary": "Get Workvivo JWT for a given agentId", | |
| "operationId": "generateJwt", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "mobile", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WorkvivoJwtResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/website/{agentIdOrSlug}": { | |
| "get": { | |
| "tags": [ | |
| "agent-website-controller" | |
| ], | |
| "summary": "Get agent website by id or slug", | |
| "operationId": "getWebsiteByAgentIdOrSlug", | |
| "parameters": [ | |
| { | |
| "name": "agentIdOrSlug", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentWebsiteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/{userId}/personal-account": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get personal account", | |
| "operationId": "getPersonalAccount", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PersonalAccountResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/{userId}/experiments": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get all experiment", | |
| "operationId": "getBoundExperiments", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "X-real-app-name", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BoundExperimentsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/{userId}/experiments/{name}": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get experiment by name", | |
| "operationId": "getBoundExperiment", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "X-real-app-name", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BoundExperimentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/{userId}/check-permissions": { | |
| "get": { | |
| "tags": [ | |
| "users-check-permissions-controller" | |
| ], | |
| "operationId": "checkPermission", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "action", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "READ", | |
| "WRITE" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/{id}/announce-kit": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get announce kit types by User ID", | |
| "operationId": "getAnnounceKitTypesUserById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/skySlope/{skySlopeId}": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get user by SkySlope id", | |
| "operationId": "getUserBySkySlopeId", | |
| "parameters": [ | |
| { | |
| "name": "skySlopeId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/myprincipal": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get current user UserPrincipal", | |
| "operationId": "getCurrentUserPrincipal", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserPrincipal" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/me": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get current user", | |
| "operationId": "getCurrentUser", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/keymaker-ids": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get all the keymaker ids for the Users with the given Yenta ids", | |
| "operationId": "getKeymakerIds", | |
| "parameters": [ | |
| { | |
| "name": "yentaIds", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/joined-before-date-count": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get users who joined before date count", | |
| "operationId": "getUsersJoinedBeforeDateCount", | |
| "parameters": [ | |
| { | |
| "name": "date", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/generic/{id}": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get user by id", | |
| "operationId": "getGenericUserById", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/generic/me": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get current generic user", | |
| "operationId": "getCurrentGenericUser", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.UserResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/count": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get users count", | |
| "operationId": "getUsersCount", | |
| "parameters": [ | |
| { | |
| "name": "terminatedOnly", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/active-non-reportable-count": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get active non reportable users count", | |
| "operationId": "getActiveNonReportableUsersByTypeCount", | |
| "parameters": [ | |
| { | |
| "name": "userType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "AGENT", | |
| "BROKER", | |
| "LOAN_OFFICER", | |
| "GENERIC" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/users/active-count": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get active users by type count", | |
| "operationId": "getActiveUsersByType", | |
| "parameters": [ | |
| { | |
| "name": "userType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "AGENT", | |
| "BROKER", | |
| "LOAN_OFFICER", | |
| "GENERIC" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/{userId}/unsigned": { | |
| "get": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Create new agreements and amendments if they do not exist and return all unsigned agreements for specified agreement definitions", | |
| "operationId": "getUnsignedAgreementsByDefinitions", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agreementDefinitionId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.AgreementResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/{id}": { | |
| "get": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Get agreement by id", | |
| "operationId": "getAgreement", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/latest-not-signed": { | |
| "get": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Get latest agreement version that is not signed", | |
| "operationId": "getLatestAgreementVersionNotSigned", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agreementType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "WILLABLE_REVSHARE", | |
| "LOI", | |
| "ICA", | |
| "BUYER_BROKER", | |
| "UNLICENSED_ASSISTANT_ADDENDUM", | |
| "LICENSED_ASSISTANT_ADDENDUM", | |
| "ASSISTANT_ACCESS_AGREEMENT", | |
| "ASSISTANT_POLICY_AND_PROCEDURES", | |
| "AGENT_REFERRAL", | |
| "WALLET_DEBIT", | |
| "WALLET_CREDIT", | |
| "WALLET_LENDING", | |
| "AGENT_REINSTATE_AGREEMENT" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/criteria": { | |
| "get": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Get agreement by criteria", | |
| "operationId": "getAgreementsByUserAndAgreementTypeAndVersionDesc", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "signed", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "agreementType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "WILLABLE_REVSHARE", | |
| "LOI", | |
| "ICA", | |
| "BUYER_BROKER", | |
| "UNLICENSED_ASSISTANT_ADDENDUM", | |
| "LICENSED_ASSISTANT_ADDENDUM", | |
| "ASSISTANT_ACCESS_AGREEMENT", | |
| "ASSISTANT_POLICY_AND_PROCEDURES", | |
| "AGENT_REFERRAL", | |
| "WALLET_DEBIT", | |
| "WALLET_CREDIT", | |
| "WALLET_LENDING", | |
| "AGENT_REINSTATE_AGREEMENT" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.AgreementResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/user-agreements/all-my-latest-not-signed": { | |
| "get": { | |
| "tags": [ | |
| "user-agreement-controller" | |
| ], | |
| "summary": "Create new agreements and amendments if it does not exist and return all agreement that is not signed for the logged in user", | |
| "operationId": "getAllLatestMandatoryAgreementsNotSigned", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.AgreementResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections": { | |
| "get": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Get Transaction Coordinator Connections", | |
| "operationId": "getConnections", | |
| "parameters": [ | |
| { | |
| "name": "connectionParticipantIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "transactionCoordinatorId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agentIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "associatedTeamId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "teamId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 10 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "DESC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ID", | |
| "CREATED_AT", | |
| "UPDATED_AT" | |
| ] | |
| }, | |
| "default": [ | |
| "CREATED_AT" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "connectionStatuses", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "PENDING", | |
| "REVOKED", | |
| "EXPIRED", | |
| "REJECTED", | |
| "ACTIVE", | |
| "VOIDED", | |
| "DELETED" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "searchCustomizations", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ONLY_AGENT_CONNECTIONS" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "connectionId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "permissions", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "NEW_TRANSACTION", | |
| "ALL_EXISTING_TRANSACTIONS", | |
| "EXISTING_TRANSACTION_IF_ADDED_AS_PARTICIPANT", | |
| "CREATE_TRANSACTION" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericSearchResponseTransactionCoordinatorConnectionViewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/transaction-coordinators/connections/statistics/counts-by-status": { | |
| "get": { | |
| "tags": [ | |
| "transaction-coordinator-controller" | |
| ], | |
| "summary": "Get Transaction Coordinator Connection Count Grouped By Status", | |
| "operationId": "getConnectionCountGroupedByStatus", | |
| "parameters": [ | |
| { | |
| "name": "connectionParticipantId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "teamId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "transactionCoordinatorId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ConnectionCountGroupedByStatusResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/teams": { | |
| "get": { | |
| "tags": [ | |
| "team-controller" | |
| ], | |
| "summary": "Search teams given a set of criteria", | |
| "operationId": "search", | |
| "parameters": [ | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "ASC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ID", | |
| "NAME", | |
| "STATUS", | |
| "TEAM_TYPE", | |
| "LEADER_NAME", | |
| "CREATED_AT" | |
| ] | |
| }, | |
| "default": [ | |
| "NAME" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "status", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "INACTIVE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "createdAtStart", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "createdAtEnd", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "teamType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "NORMAL", | |
| "PLATINUM", | |
| "GROUP", | |
| "DOMESTIC", | |
| "PRO" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericSearchResponseTeamResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/teams/{id}/without-agents": { | |
| "get": { | |
| "tags": [ | |
| "team-controller" | |
| ], | |
| "summary": "Get team by id without agents", | |
| "operationId": "getTeamByIdWithoutAgents", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TeamWithoutAgentsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/{stateOrProvince}/state-default/{role}": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get list of users from default regional office in state for a given role and for given administrative area", | |
| "operationId": "getUsersFromDefaultOfficeInState", | |
| "parameters": [ | |
| { | |
| "name": "stateOrProvince", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "role", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "DESIGNATED_BROKER", | |
| "REGIONAL_BROKER", | |
| "MANAGING_BROKER", | |
| "SETTLEMENT_SPECIALIST", | |
| "FINANCE_SPECIALIST", | |
| "CONTRACT_SPECIALIST", | |
| "AGENT_EXPERIENCE", | |
| "NONE" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentPublicInfosResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/{officeId}/visible-groups": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get groups visible to the user", | |
| "operationId": "getVisibleOfficeGroups", | |
| "parameters": [ | |
| { | |
| "name": "officeId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.OfficeGroupResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/{officeId}/mentionable-groups": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get office groups with fallback to regional and global office groups", | |
| "operationId": "getMentionableOfficeGroups", | |
| "parameters": [ | |
| { | |
| "name": "officeId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.OfficeGroupResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/{officeId}/check-permissions": { | |
| "get": { | |
| "tags": [ | |
| "check-permissions-controller" | |
| ], | |
| "operationId": "checkPermission_1", | |
| "parameters": [ | |
| { | |
| "name": "officeId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "action", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "READ", | |
| "WRITE" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/visible-groups": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get groups visible to the user", | |
| "operationId": "getVisibleGroupsInOffices", | |
| "parameters": [ | |
| { | |
| "name": "officeId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "default": [] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.OfficeGroupResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/regional/{role}": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get list of users from all default regional offices for a given role", | |
| "operationId": "getRegionalOfficeUsersByRole", | |
| "parameters": [ | |
| { | |
| "name": "role", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "DESIGNATED_BROKER", | |
| "REGIONAL_BROKER", | |
| "MANAGING_BROKER", | |
| "SETTLEMENT_SPECIALIST", | |
| "FINANCE_SPECIALIST", | |
| "CONTRACT_SPECIALIST", | |
| "AGENT_EXPERIENCE", | |
| "NONE" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.AgentPublicInfo" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/global": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get global office", | |
| "operationId": "getGlobalOffice", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.OfficeResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/default/{stateOrProvince}": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get default office in state/province", | |
| "operationId": "getDefaultOfficeInState", | |
| "parameters": [ | |
| { | |
| "name": "stateOrProvince", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.OfficeResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/default/all": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get all default offices", | |
| "operationId": "getAllDefaultOffices", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.OfficeResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/offices/administrative-area/{administrativeAreaId}": { | |
| "get": { | |
| "tags": [ | |
| "office-controller" | |
| ], | |
| "summary": "Get all offices for a given administrative area ID", | |
| "operationId": "getAllOfficesInAdminArea", | |
| "parameters": [ | |
| { | |
| "name": "administrativeAreaId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.OfficePreviewResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/notes/{noteId}": { | |
| "get": { | |
| "tags": [ | |
| "note-controller" | |
| ], | |
| "summary": "Get Note by id", | |
| "operationId": "getNoteById", | |
| "parameters": [ | |
| { | |
| "name": "noteId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.NoteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/notes/{entityType}/{entityId}": { | |
| "get": { | |
| "tags": [ | |
| "note-controller" | |
| ], | |
| "summary": "Get Notes for a given entityType and entityId", | |
| "operationId": "getNoteById_1", | |
| "parameters": [ | |
| { | |
| "name": "entityType", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "APPLICATION", | |
| "TRANSACTION", | |
| "AGENT", | |
| "MLS", | |
| "BOARD", | |
| "TEAM" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "entityId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.NotesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/mls/search/lite": { | |
| "get": { | |
| "tags": [ | |
| "mls-controller" | |
| ], | |
| "summary": "Search MLSs with limited information", | |
| "operationId": "searchLiteMls", | |
| "parameters": [ | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "ASC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "state", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericSearchResponseMlsPublicResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/ica/latest-not-signed": { | |
| "get": { | |
| "tags": [ | |
| "ica-controller" | |
| ], | |
| "summary": "Get latest ica that is not signed", | |
| "operationId": "getLatestICAAgreement", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/vendors/search/all": { | |
| "get": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Get all vendors (accessible to logged-in user) with paging, sorting, and filtering.", | |
| "operationId": "getAllVendors", | |
| "parameters": [ | |
| { | |
| "name": "isArchived", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| }, | |
| { | |
| "name": "isVerified", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "hasLinkedPersons", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "nationalBusinessId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "emailAddress", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "phoneNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "street", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "city", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "postal", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "stateOrProvince", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "country", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "UNITED_STATES", | |
| "CANADA" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "administrativeAreaIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "roles", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "CLIENT", | |
| "LANDLORD", | |
| "TENANT", | |
| "TITLE_ESCROW", | |
| "LENDER", | |
| "LAWYER", | |
| "TRUSTEE", | |
| "OTHER_AGENT", | |
| "VENDOR", | |
| "REFERRAL", | |
| "OTHER" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "NAME", | |
| "EMAIL_ADDRESS", | |
| "PHONE_NUMBER", | |
| "CITY", | |
| "STATE_OR_PROVINCE", | |
| "STATUS" | |
| ] | |
| }, | |
| "default": [ | |
| "NAME" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PagedVendorResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/roles": { | |
| "get": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Get roles available for directory entries. May be filtered by entry type.", | |
| "operationId": "getPermittedRoles", | |
| "parameters": [ | |
| { | |
| "name": "entryType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "VENDOR", | |
| "PERSON" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DirectoryEntryPermittedRolesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/persons/search/all": { | |
| "get": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Get all persons (accessible to logged-in user) with paging, sorting, and filtering.", | |
| "operationId": "getAllPersons", | |
| "parameters": [ | |
| { | |
| "name": "isArchived", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| }, | |
| { | |
| "name": "isPublic", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "isLinkedToVendor", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "firstName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "lastName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "emailAddress", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "phoneNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "roles", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "CLIENT", | |
| "LANDLORD", | |
| "TENANT", | |
| "TITLE_ESCROW", | |
| "LENDER", | |
| "LAWYER", | |
| "TRUSTEE", | |
| "OTHER_AGENT", | |
| "VENDOR", | |
| "REFERRAL", | |
| "OTHER" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "FIRST_NAME", | |
| "LAST_NAME", | |
| "EMAIL_ADDRESS", | |
| "PHONE_NUMBER", | |
| "IS_PUBLIC" | |
| ] | |
| }, | |
| "default": [ | |
| "LAST_NAME" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PagedPersonResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/directory/entries/search/all": { | |
| "get": { | |
| "tags": [ | |
| "directory-controller" | |
| ], | |
| "summary": "Get all vendors and persons (accessible to logged-in user) with paging, sorting, and filtering.", | |
| "operationId": "getAllEntries", | |
| "parameters": [ | |
| { | |
| "name": "isArchived", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| }, | |
| { | |
| "name": "isVerified", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "nationalBusinessId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "emailAddress", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "phoneNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "street", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "city", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "postal", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "stateOrProvince", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "country", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "UNITED_STATES", | |
| "CANADA" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "administrativeAreaIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "roles", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "CLIENT", | |
| "LANDLORD", | |
| "TENANT", | |
| "TITLE_ESCROW", | |
| "LENDER", | |
| "LAWYER", | |
| "TRUSTEE", | |
| "OTHER_AGENT", | |
| "VENDOR", | |
| "REFERRAL", | |
| "OTHER" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "createdBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "NAME", | |
| "NAME_LOGICAL", | |
| "EMAIL_ADDRESS", | |
| "PHONE_NUMBER", | |
| "CITY", | |
| "STATE_OR_PROVINCE", | |
| "STATUS" | |
| ] | |
| }, | |
| "default": [ | |
| "NAME" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PagedDirectoryEntryResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/design-center/{agentId}/jwt": { | |
| "get": { | |
| "tags": [ | |
| "design-center-controller" | |
| ], | |
| "summary": "Get JWT for Real Design Center for a given agentId", | |
| "operationId": "getJwtForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DesignCenterJwtResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/coupons/{code}": { | |
| "get": { | |
| "tags": [ | |
| "promotion-code-controller" | |
| ], | |
| "summary": "Gets the promotion code obj given the code", | |
| "operationId": "retrievePromotionCode", | |
| "parameters": [ | |
| { | |
| "name": "code", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "pattern": "^[a-zA-Z0-9]*$", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PromotionCodeResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/countries": { | |
| "get": { | |
| "tags": [ | |
| "country-controller" | |
| ], | |
| "summary": "Retrieves the names of all available countries for input", | |
| "operationId": "getCountries", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GetCountriesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/calendar/events/{tab}/agent/{agentId}": { | |
| "get": { | |
| "tags": [ | |
| "calendar-controller" | |
| ], | |
| "summary": "Gets calendar events for an agent for the corresponding tab", | |
| "operationId": "getEventsForAgent", | |
| "parameters": [ | |
| { | |
| "name": "tab", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ALL", | |
| "PAST", | |
| "UPCOMING", | |
| "YES", | |
| "NO", | |
| "MAYBE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "calendarIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.CalendarEventResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/calendar/events/agent/{agentId}/count": { | |
| "get": { | |
| "tags": [ | |
| "calendar-controller" | |
| ], | |
| "summary": "Counts the number of calendar events for an agent for the corresponding tab", | |
| "operationId": "countEventsForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "calendarIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CalendarCountOverviewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/calendar/event/{calendarEventId}/invitees": { | |
| "get": { | |
| "tags": [ | |
| "calendar-controller" | |
| ], | |
| "summary": "Gets list of calendar event invitees", | |
| "operationId": "getCalendarEventInviteesDeprecated", | |
| "parameters": [ | |
| { | |
| "name": "calendarEventId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.CalendarEventInviteeResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/calendar/event/{calendarEventId}/invitees/rsvp/{rsvpStatus}/{pageNumber}/{pageSize}": { | |
| "get": { | |
| "tags": [ | |
| "calendar-controller" | |
| ], | |
| "summary": "Get paginated list of invitees for a given event for a particular rsvp status", | |
| "operationId": "getCalendarEventInviteesPaginated", | |
| "parameters": [ | |
| { | |
| "name": "calendarEventId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "rsvpStatus", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "YES", | |
| "NO", | |
| "MAYBE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CalendarEventInviteePaginatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/calendar/event/{calendarEventId}/invitees/count": { | |
| "get": { | |
| "tags": [ | |
| "calendar-controller" | |
| ], | |
| "summary": "Gets count of invitees by RSVP type", | |
| "operationId": "getCalendarEventInviteesCount", | |
| "parameters": [ | |
| { | |
| "name": "calendarEventId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CalendarInviteesCountResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/calendar/all": { | |
| "get": { | |
| "tags": [ | |
| "calendar-controller" | |
| ], | |
| "summary": "Gets all calendar infos", | |
| "operationId": "getAllCalendarInfos", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.CalendarInfoResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/calendar/agent/{agentId}": { | |
| "get": { | |
| "tags": [ | |
| "calendar-controller" | |
| ], | |
| "summary": "Get all calendars for a given agent", | |
| "operationId": "getCalendarsForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CalendarInfosResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/buyer-broker-agreements/{id}/download-url": { | |
| "get": { | |
| "tags": [ | |
| "buyer-broker-agreement-controller" | |
| ], | |
| "summary": "Retrieve the buyer broker agreement file URL", | |
| "operationId": "getBuyerBrokerAgreementDownloadFileUrl", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementFileUrlResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/buyer-broker-agreements/search": { | |
| "get": { | |
| "tags": [ | |
| "buyer-broker-agreement-controller" | |
| ], | |
| "summary": "Search a Buyer broker agreement", | |
| "operationId": "searchBuyerBrokerAgreement", | |
| "parameters": [ | |
| { | |
| "name": "agreementDefinitionId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "viewType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "SIGNED", | |
| "INCOMPLETE", | |
| "VOIDED" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 10 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "DESC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "NAME", | |
| "CREATED_AT", | |
| "UPDATED_AT" | |
| ] | |
| }, | |
| "default": [ | |
| "CREATED_AT" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "userId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.BuyerBrokerAgreementPageableResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/boards/search/all": { | |
| "get": { | |
| "tags": [ | |
| "board-controller" | |
| ], | |
| "summary": "Search Boards", | |
| "operationId": "searchBoards", | |
| "parameters": [ | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ID", | |
| "NAME", | |
| "CODE", | |
| "JOIN_DATE", | |
| "STATUS" | |
| ] | |
| }, | |
| "default": [ | |
| "NAME" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "ASC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "code", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "states", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "statuses", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "NOT_MEMBERS", | |
| "PENDING", | |
| "ACTIVE", | |
| "INACTIVE", | |
| "WILLING_TO_JOIN" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericSearchResponseBoardResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/banners/dynamic": { | |
| "get": { | |
| "tags": [ | |
| "banner-controller" | |
| ], | |
| "summary": "Get Dynamic banners which are not stored on db and made based real time data", | |
| "operationId": "getDynamicBanners", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "teamId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.BannerResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "barer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/banners/active": { | |
| "get": { | |
| "tags": [ | |
| "banner-controller" | |
| ], | |
| "summary": "Get active banners for the current user", | |
| "operationId": "getActiveBanners", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.BannerResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/{id}/license-images": { | |
| "get": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Gets application license images", | |
| "operationId": "getApplicationLicenseImages", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationLicenseImagesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/{id}/ica": { | |
| "get": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Get a URL to the signed ICA pdf", | |
| "operationId": "getICAUrl", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/onboardings": { | |
| "get": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Get all onboarding applications", | |
| "operationId": "getOnboardingApplications", | |
| "parameters": [ | |
| { | |
| "name": "firstName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "lastName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "email", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "statuses", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "CREATED", | |
| "STARTED", | |
| "SIGN_ICA", | |
| "ICA_SIGNED", | |
| "PAY_FEES", | |
| "FEES_PAID", | |
| "TRANSFER_LICENSE", | |
| "LICENSE_TRANSFERRED", | |
| "JOIN_MLS", | |
| "MLS_JOINED", | |
| "JOIN_BOARD", | |
| "BOARD_JOINED", | |
| "PENDING_APPROVAL", | |
| "APPROVED", | |
| "REJECTED", | |
| "SIGN_LETTER_OF_INTENT", | |
| "LETTER_OF_INTENT_SIGNED", | |
| "FEES_WAIVED" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "phoneNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "stateOrProvinces", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "createdAtStart", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "createdAtEnd", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "updatedAtStart", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "updatedAtEnd", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "hasPendingTransactionsWithCurrentBrokerage", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "FIRST_NAME", | |
| "LAST_NAME", | |
| "EMAIL", | |
| "STATUS", | |
| "CREATED_AT", | |
| "UPDATED_AT", | |
| "HAS_PENDING_TRANSACTIONS_WITH_CURRENT_BROKERAGE" | |
| ] | |
| } | |
| } | |
| }, | |
| { | |
| "name": "searchText", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "roles", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION_COORDINATOR", | |
| "AGENT", | |
| "TEAM_ADMIN" | |
| ] | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ApplicationsPaginatedResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/applications/calculate_amount_discount_info": { | |
| "get": { | |
| "tags": [ | |
| "application-controller" | |
| ], | |
| "summary": "Calculate the amount discount info for a given coupon code and amount", | |
| "operationId": "calculateAmountDiscountInfo", | |
| "parameters": [ | |
| { | |
| "name": "applicationId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "couponCode", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "pattern": "^[a-zA-Z0-9]*$", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "amount", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AmountDiscountResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agreement-definitions/search": { | |
| "get": { | |
| "tags": [ | |
| "agreement-definition-controller" | |
| ], | |
| "summary": "Search agreement definitions", | |
| "operationId": "searchAgreementDefinitions", | |
| "parameters": [ | |
| { | |
| "name": "agreementType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "WILLABLE_REVSHARE", | |
| "LOI", | |
| "ICA", | |
| "BUYER_BROKER", | |
| "UNLICENSED_ASSISTANT_ADDENDUM", | |
| "LICENSED_ASSISTANT_ADDENDUM", | |
| "ASSISTANT_ACCESS_AGREEMENT", | |
| "ASSISTANT_POLICY_AND_PROCEDURES", | |
| "AGENT_REFERRAL", | |
| "WALLET_DEBIT", | |
| "WALLET_CREDIT", | |
| "WALLET_LENDING", | |
| "AGENT_REINSTATE_AGREEMENT" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "stateOrProvince", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "state", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ACTIVE", | |
| "CREATED", | |
| "ARCHIVED" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "page", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "size", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 10 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "DESC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "NAME", | |
| "CREATED_AT", | |
| "UPDATED_AT" | |
| ] | |
| }, | |
| "default": [ | |
| "CREATED_AT" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementDefinitionPageableResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agreement-definitions/recently-updated": { | |
| "get": { | |
| "tags": [ | |
| "agreement-definition-controller" | |
| ], | |
| "summary": "Get recently updated Document templates", | |
| "operationId": "getRecentlyUpdatedAgreementDefinitions", | |
| "parameters": [ | |
| { | |
| "name": "agreementType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "WILLABLE_REVSHARE", | |
| "LOI", | |
| "ICA", | |
| "BUYER_BROKER", | |
| "UNLICENSED_ASSISTANT_ADDENDUM", | |
| "LICENSED_ASSISTANT_ADDENDUM", | |
| "ASSISTANT_ACCESS_AGREEMENT", | |
| "ASSISTANT_POLICY_AND_PROCEDURES", | |
| "AGENT_REFERRAL", | |
| "WALLET_DEBIT", | |
| "WALLET_CREDIT", | |
| "WALLET_LENDING", | |
| "AGENT_REINSTATE_AGREEMENT" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "stateOrProvince", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "recentCount", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 5 | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgreementDefinitionPreviewResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent(s) by email address", | |
| "operationId": "getAgentsByEmail", | |
| "parameters": [ | |
| { | |
| "name": "emailAddress", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/sponsor-tree": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent's sponsor tree", | |
| "operationId": "getSponsorTree", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.SponsorTreeResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/profile-score": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get User's Profile Score", | |
| "operationId": "getProfileScore", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentProfileScoreResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/front-line-agents-info": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get front line agents basic information", | |
| "operationId": "getFrontLineAgentsInfo", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.FrontLineAgentInfoResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{id}/down-line/{tier}": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agents in the network within a specific tier of the given agent", | |
| "operationId": "getDownLineAgents", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "tier", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "updatedAtFrom", | |
| "in": "query", | |
| "description": "start date for updatedAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-01" | |
| }, | |
| { | |
| "name": "updatedAtTo", | |
| "in": "query", | |
| "description": "end date for updatedAt filter", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "example": "2025-01-31" | |
| }, | |
| { | |
| "name": "statusIn", | |
| "in": "query", | |
| "description": "filters agents by status, defaults to ACTIVE if not specified", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "CANDIDATE", | |
| "ACTIVE", | |
| "INACTIVE", | |
| "REJECTED", | |
| "RESURRECTING" | |
| ] | |
| } | |
| }, | |
| "example": "ACTIVE" | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "description": "page number for pagination", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "example": 0 | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "description": "page size for pagination", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "example": 20 | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.DownLineAgentsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/will-beneficiary-typed": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent's will beneficiary", | |
| "operationId": "getWillBeneficiaryAndTypeForAgent", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.WillBeneficiaryAndTypeResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/tax-forms/summary": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get tax forms summary for an agent", | |
| "operationId": "getTaxFormsSummary", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TaxFormsSummaryResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/tax-forms-lite": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get all tax forms (lite) for a given user", | |
| "operationId": "getTaxFormsLite", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TaxFormsLiteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/tax-forms-lite/{taxFormId}": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get a specific tax form (lite) for a given user", | |
| "operationId": "getTaxFormLite", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "taxFormId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TaxFormLiteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/tax-forms-lite/latest-personal": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get the latest personal tax form (including historical records) for an agent. Used for Shareworks awards assignment.", | |
| "operationId": "getLatestPersonalTaxFormLite", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.TaxFormLiteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/payment-settings/history": { | |
| "get": { | |
| "tags": [ | |
| "payment-settings-controller" | |
| ], | |
| "summary": "Search payment settings history with the given criteria", | |
| "operationId": "searchPaymentSettings", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ID", | |
| "EFFECTIVE_DATE", | |
| "PAYMENT_METHOD" | |
| ] | |
| }, | |
| "default": [ | |
| "EFFECTIVE_DATE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "maximum": 50, | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "DESC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericSearchResponsePaymentSettingsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/payment-details": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get agent's payment details", | |
| "operationId": "getPaymentDetails", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PaymentDetails" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/payment-details/payable-info": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get agent's payable info", | |
| "operationId": "getPayableInfo", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PayableInfoResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/network-size-by-tier": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get network size by tier", | |
| "operationId": "getNetworkSizeByTier", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "asOfDate", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.NetworkSizeByTierResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/masked-tax-forms-lite": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get masked tax forms (lite) for a given user", | |
| "operationId": "getMaskedTaxFormsLite", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.MaskedTaxFormsLiteResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/{agentId}/masked-payment-methods": { | |
| "get": { | |
| "tags": [ | |
| "payment-details-controller" | |
| ], | |
| "summary": "Get all masked payment methods for a given user", | |
| "operationId": "getMaskedPaymentMethods", | |
| "parameters": [ | |
| { | |
| "name": "agentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.MaskedPaymentMethodsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/tipaltiUrl": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get user by id", | |
| "operationId": "getTipaltiSignUpUrl", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.PayeeDetailsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/slugs/{slug}/available": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Return whether or not a slug is available", | |
| "operationId": "isSlugAvailable", | |
| "parameters": [ | |
| { | |
| "name": "slug", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AvailabilityResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/search/active": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Search for active agents", | |
| "operationId": "searchActiveAgents", | |
| "parameters": [ | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "ASC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ID", | |
| "FIRST_NAME", | |
| "LAST_NAME", | |
| "EMAIL_ADDRESS", | |
| "ACCOUNT_COUNTRY" | |
| ] | |
| }, | |
| "default": [ | |
| "FIRST_NAME", | |
| "LAST_NAME" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "nonReportable", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "boolean" | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "country", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "UNITED_STATES", | |
| "CANADA" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "stateOrProvince", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "ALABAMA", | |
| "ALASKA", | |
| "ARIZONA", | |
| "ARKANSAS", | |
| "CALIFORNIA", | |
| "COLORADO", | |
| "CONNECTICUT", | |
| "DELAWARE", | |
| "DISTRICT_OF_COLUMBIA", | |
| "FLORIDA", | |
| "GEORGIA", | |
| "HAWAII", | |
| "IDAHO", | |
| "ILLINOIS", | |
| "INDIANA", | |
| "IOWA", | |
| "KANSAS", | |
| "KENTUCKY", | |
| "LOUISIANA", | |
| "MAINE", | |
| "MARYLAND", | |
| "MASSACHUSETTS", | |
| "MICHIGAN", | |
| "MINNESOTA", | |
| "MISSISSIPPI", | |
| "MISSOURI", | |
| "MONTANA", | |
| "NEBRASKA", | |
| "NEVADA", | |
| "NEW_HAMPSHIRE", | |
| "NEW_JERSEY", | |
| "NEW_MEXICO", | |
| "NEW_YORK", | |
| "NORTH_CAROLINA", | |
| "NORTH_DAKOTA", | |
| "OHIO", | |
| "OKLAHOMA", | |
| "OREGON", | |
| "PENNSYLVANIA", | |
| "RHODE_ISLAND", | |
| "SOUTH_CAROLINA", | |
| "SOUTH_DAKOTA", | |
| "TENNESSEE", | |
| "TEXAS", | |
| "UTAH", | |
| "VERMONT", | |
| "VIRGINIA", | |
| "WASHINGTON", | |
| "WEST_VIRGINIA", | |
| "WISCONSIN", | |
| "WYOMING", | |
| "PUERTO_RICO", | |
| "ALBERTA", | |
| "BRITISH_COLUMBIA", | |
| "MANITOBA", | |
| "NEW_BRUNSWICK", | |
| "NEWFOUNDLAND_AND_LABRADOR", | |
| "NOVA_SCOTIA", | |
| "ONTARIO", | |
| "PRINCE_EDWARD_ISLAND", | |
| "QUEBEC", | |
| "SASKATCHEWAN" | |
| ] | |
| }, | |
| "default": [] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.GenericSearchResponseAgentPublicInfoWithAdminAreas" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/referral-central": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get Agents' ReferralCentral Details", | |
| "operationId": "getAgentsReferralCentralDetails", | |
| "parameters": [ | |
| { | |
| "name": "agentIds", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentsReferralCentralDetailsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/plans/revenue_share/{id}": { | |
| "get": { | |
| "tags": [ | |
| "agent-plan-controller" | |
| ], | |
| "summary": "Get revenue sharing plan by id", | |
| "operationId": "getRevenueSharePlan", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.RevenueSharePlanResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/plans/equity_purchase/{id}": { | |
| "get": { | |
| "tags": [ | |
| "agent-plan-controller" | |
| ], | |
| "summary": "Get equity purchase plan by id", | |
| "operationId": "getEquityPurchasePlan", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.EquityPurchasePlanResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/plans/equity_award/{id}": { | |
| "get": { | |
| "tags": [ | |
| "agent-plan-controller" | |
| ], | |
| "summary": "Get equity award plan by id", | |
| "operationId": "getEquityAwardPlan", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.EquityAwardPlanResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/plans/elite_equity_award/{id}": { | |
| "get": { | |
| "tags": [ | |
| "agent-plan-controller" | |
| ], | |
| "summary": "Get elite equity award plan id", | |
| "operationId": "getEliteEquityAwardPlan", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.EliteEquityAwardPlanResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/plans/commission/{id}": { | |
| "get": { | |
| "tags": [ | |
| "agent-plan-controller" | |
| ], | |
| "summary": "Get commission plan by id", | |
| "operationId": "getCommissionPlan", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CommissionPlanResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/plans/commission/official": { | |
| "get": { | |
| "tags": [ | |
| "agent-plan-controller" | |
| ], | |
| "summary": "Get official commission plan by country", | |
| "operationId": "getCommissionPlanByCountry", | |
| "parameters": [ | |
| { | |
| "name": "country", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "UNITED_STATES", | |
| "CANADA" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.CommissionPlanResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/plans/commission/basic-info": { | |
| "get": { | |
| "tags": [ | |
| "agent-plan-controller" | |
| ], | |
| "summary": "Get all commission plan basic info", | |
| "operationId": "getAllCommissionPlansBasicInfo", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AllCommissionPlansBasicInfoResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/opcity": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get Opcity", | |
| "operationId": "getOpcity", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/me": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get current agent", | |
| "operationId": "getMe", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/loiAgent": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get the agent we use as a stand-in for LOI agents in revShare trees", | |
| "operationId": "getLOIAgent", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/license/{licenseId}/images": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Gets agent's license and signature images", | |
| "operationId": "getAgentLicenseImages", | |
| "parameters": [ | |
| { | |
| "name": "licenseId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentLicenseImagesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/ids": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agents by ids (limit 20)", | |
| "operationId": "getAgentsByIds", | |
| "parameters": [ | |
| { | |
| "name": "ids", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentListResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/comment-details/{keymakerIds}": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Returns the minimal agent details needed to render a comment. Can request multiple keymaker ids", | |
| "operationId": "getAgentCommentDetails", | |
| "parameters": [ | |
| { | |
| "name": "keymakerIds", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yenta.AgentCommentDetails" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/by-anniversary": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get agent ids by anniversary month", | |
| "operationId": "getAgentIdsByAnniversaryMonthAndCountry", | |
| "parameters": [ | |
| { | |
| "name": "month", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "maximum": 12, | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "country", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "UNITED_STATES", | |
| "CANADA" | |
| ] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/active": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get all active agent IDs", | |
| "operationId": "getAllActiveAgents", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.ActiveAgentsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/agents/active-agent-ids": { | |
| "get": { | |
| "tags": [ | |
| "agent-controller" | |
| ], | |
| "summary": "Get active agent ids created on or after a given date", | |
| "operationId": "getActiveAgentIds", | |
| "parameters": [ | |
| { | |
| "name": "joinedAfter", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "date" | |
| } | |
| }, | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 100 | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yenta.AgentIdsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yenta.therealbrokerage.com/api/v1/buyer-broker-agreements/{id}": { | |
| "delete": { | |
| "tags": [ | |
| "buyer-broker-agreement-controller" | |
| ], | |
| "summary": "Delete a Buyer broker agreement", | |
| "operationId": "deleteBuyerBrokerAgreement", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://hermes.therealbrokerage.com/api/v1/users/{realUsername}/notification-preferences/publisher": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get user's notification preferences for a given publisher", | |
| "operationId": "getPublisherNotificationPreferences", | |
| "parameters": [ | |
| { | |
| "name": "realUsername", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "publisherType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION", | |
| "REFERRAL", | |
| "INTERNAL_REFERRAL", | |
| "LISTING", | |
| "CHECKLIST_ITEM", | |
| "DROPBOX", | |
| "REAL", | |
| "OFFICE", | |
| "LOAN", | |
| "AGENT", | |
| "AGENT_DEBT", | |
| "BORROWER", | |
| "MORTGAGE_LEAD", | |
| "APPLICATION", | |
| "CHECKLIST", | |
| "EMAIL", | |
| "COMMENT", | |
| "TEAM", | |
| "OUTGOING_PAYMENT", | |
| "WALLET", | |
| "PAYMENT", | |
| "CREDIT_PROFILE", | |
| "VOICE", | |
| "MLS", | |
| "BOARD", | |
| "USER", | |
| "CONVERSATION", | |
| "MUFASA_CONVERSATION", | |
| "REFERRAL_CENTRAL", | |
| "SIGNATURE_DOCUMENT", | |
| "SIGNATURE_PACKET", | |
| "USER_AGREEMENT", | |
| "CONNECTION", | |
| "TRANSACTION_COORDINATOR_CONNECTION", | |
| "COMMISSION_ADVANCE", | |
| "LEO_DOCUMENT_REVIEW", | |
| "LEO_MATERIAL_REVIEW", | |
| "SURVEY", | |
| "TITLE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "publisherId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.PublisherNotificationPreferencesDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Update user's notification preferences for a given publisher", | |
| "operationId": "mutePublisherChannel", | |
| "parameters": [ | |
| { | |
| "name": "realUsername", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.UpdatePublisherNotificationPreferencesDto" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.PublisherNotificationPreferencesDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://hermes.therealbrokerage.com/api/v1/users/{realUsername}/notification-preferences/global": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get user's notification preferences", | |
| "operationId": "getNotificationPreferences", | |
| "parameters": [ | |
| { | |
| "name": "realUsername", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.GlobalNotificationPreferencesDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Update user's global notification preferences that are applied to all publishers", | |
| "operationId": "updateGlobalNotificationPreferences", | |
| "parameters": [ | |
| { | |
| "name": "realUsername", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.UpdateNotificationPreferencesDto" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.GlobalNotificationPreferencesDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://hermes.therealbrokerage.com/api/v1/users/join-real-email": { | |
| "put": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Update join real email -- DEPRECATED -- use POST /username instead", | |
| "operationId": "updateJoinRealEmail", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.UpdateJoinRealEmailRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://hermes.therealbrokerage.com/api/v1/pushNotifications/register": { | |
| "put": { | |
| "tags": [ | |
| "push-notification-controller" | |
| ], | |
| "summary": "Register a push notification token for a particular user.", | |
| "operationId": "register", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.UpdatePushNotificationRegistrationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.PushNotificationRegistrationResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://hermes.therealbrokerage.com/api/v1/users/{realUsername}/deferred-notifications": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Get all deferred notifications for user", | |
| "operationId": "getDeferredNotificationsByUsername", | |
| "parameters": [ | |
| { | |
| "name": "realUsername", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Hermes.DeferredNotificationDto" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://hermes.therealbrokerage.com/api/v1/users/join-real-email-available/{joinRealEmail}": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Check if a join real email is available", | |
| "operationId": "isJoinRealEmailAvailable", | |
| "parameters": [ | |
| { | |
| "name": "joinRealEmail", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.BooleanResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://hermes.therealbrokerage.com/api/v1/users/email-available/{email}": { | |
| "get": { | |
| "tags": [ | |
| "user-controller" | |
| ], | |
| "summary": "Check if email is available", | |
| "operationId": "isEmailAvailabile", | |
| "parameters": [ | |
| { | |
| "name": "email", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.BooleanResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated": true | |
| } | |
| }, | |
| "https://hermes.therealbrokerage.com/api/v1/emails/my/status": { | |
| "get": { | |
| "tags": [ | |
| "email-controller" | |
| ], | |
| "summary": "Check status of logged in user's email address", | |
| "operationId": "checkMyEmailStatus", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Hermes.EmailStatusResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/checklist-items/{checklistItemId}": { | |
| "get": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "Get checklistItem for given Id", | |
| "operationId": "getChecklistItemById", | |
| "parameters": [ | |
| { | |
| "name": "checklistItemId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ItemResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "update ChecklistItem for given ChecklistItemId and ChecklistItem request", | |
| "operationId": "updateChecklistItem", | |
| "parameters": [ | |
| { | |
| "name": "checklistItemId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ItemRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ItemResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "Delete ChecklistItem for given ChecklistId", | |
| "operationId": "deletedChecklistItem", | |
| "parameters": [ | |
| { | |
| "name": "checklistItemId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ApiResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/checklist-items/{checklistItemId}/complete": { | |
| "put": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "update complete", | |
| "operationId": "updateComplete", | |
| "parameters": [ | |
| { | |
| "name": "checklistItemId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "isComplete", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": true | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ItemResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/checklist-documents/{documentId}": { | |
| "get": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "Get document for the given Id", | |
| "operationId": "getDocumentById", | |
| "parameters": [ | |
| { | |
| "name": "documentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.DocumentDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "update current version for the given documentId", | |
| "operationId": "updateDocumentMeta", | |
| "parameters": [ | |
| { | |
| "name": "documentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.DocumentDto" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.DocumentDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "delete the given documentId", | |
| "operationId": "deleteDocument", | |
| "parameters": [ | |
| { | |
| "name": "documentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/sections/{sectionId}/acknowledge": { | |
| "put": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Acknowledge a section milestone", | |
| "operationId": "acknowledgeSection", | |
| "parameters": [ | |
| { | |
| "name": "sectionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/questions/{questionId}/skip": { | |
| "put": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Skip a question", | |
| "operationId": "skipQuestion", | |
| "parameters": [ | |
| { | |
| "name": "questionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/{checklistId}/items": { | |
| "post": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "Create ChecklistItem for given ChecklistId and ChecklistItem request", | |
| "operationId": "createChecklistItem", | |
| "parameters": [ | |
| { | |
| "name": "checklistId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ItemRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ItemResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/{checklistDefinitionId}": { | |
| "post": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "Create Checklist for given ChecklistDefinitionId", | |
| "operationId": "createChecklist", | |
| "parameters": [ | |
| { | |
| "name": "checklistDefinitionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.CreateChecklistRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ChecklistResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/checklist-items/{itemId}/file-references": { | |
| "post": { | |
| "tags": [ | |
| "Item" | |
| ], | |
| "summary": "Assign file references to an item", | |
| "operationId": "addFileReferences", | |
| "parameters": [ | |
| { | |
| "name": "itemId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.AddFileReferencesRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Item" | |
| ], | |
| "summary": "Remove file references from an item", | |
| "operationId": "removeFileReferences", | |
| "parameters": [ | |
| { | |
| "name": "itemId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.RemoveFileReferencesRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/checklist-items/{checklistItemId}/documents": { | |
| "post": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "add a new document to the given checklistItemId", | |
| "operationId": "uploadNewDocument", | |
| "parameters": [ | |
| { | |
| "name": "checklistItemId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.VersionUploadRequest" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.DocumentDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/checklist-documents/{checklistDocumentId}/versions": { | |
| "post": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "add a new version for given documentId", | |
| "operationId": "uploadNewVersion", | |
| "parameters": [ | |
| { | |
| "name": "checklistDocumentId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.VersionUploadRequest" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.VersionDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/batch-update": { | |
| "post": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "Update all checklists with the given ids", | |
| "operationId": "batchPatchChecklist", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.BatchPatchChecklistRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/batch-archive": { | |
| "post": { | |
| "tags": [ | |
| "Archive" | |
| ], | |
| "summary": "Archive checklists", | |
| "operationId": "archive", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.BatchArchiveRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/{applicationId}/submit": { | |
| "post": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Submit application", | |
| "operationId": "submitApplication", | |
| "parameters": [ | |
| { | |
| "name": "applicationId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/questions/{questionId}/answer": { | |
| "post": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Answer a question", | |
| "operationId": "answerQuestion", | |
| "parameters": [ | |
| { | |
| "name": "questionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.AnswerQuestionRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/create-by-id/{applicationDefinitionId}": { | |
| "post": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Create Application for given applicationDefinitionId", | |
| "operationId": "createApplicationByDefinitionId", | |
| "parameters": [ | |
| { | |
| "name": "applicationDefinitionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.CreateApplicationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/create-by-alias/{aliasName}": { | |
| "post": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Create Application by alias", | |
| "operationId": "createApplicationByAlias", | |
| "parameters": [ | |
| { | |
| "name": "aliasName", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION_COORDINATOR_APPLICATION", | |
| "TRANSACTION_COORDINATOR_APPLICATION_STATUS_CHECKLIST" | |
| ] | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.CreateApplicationRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/{checklistId}": { | |
| "get": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "Get checklist for given Id", | |
| "operationId": "getChecklistById", | |
| "parameters": [ | |
| { | |
| "name": "checklistId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ChecklistResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/progress": { | |
| "get": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "Get checklists progress for given checklist Ids", | |
| "operationId": "getChecklistProgressByIds", | |
| "parameters": [ | |
| { | |
| "name": "checklistIds", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Sherlock.ChecklistProgressResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/checklists/checklist-documents/versions/{versionId}/download": { | |
| "get": { | |
| "tags": [ | |
| "Checklist" | |
| ], | |
| "summary": "get the version url", | |
| "operationId": "getVersionUrl", | |
| "parameters": [ | |
| { | |
| "name": "versionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "string", | |
| "format": "url" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/{applicationId}/questions": { | |
| "get": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Get all question steps for section", | |
| "operationId": "getAllQuestionStepsBySection", | |
| "parameters": [ | |
| { | |
| "name": "applicationId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "sectionName", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Sherlock.ContentItem" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/{applicationId}/progress": { | |
| "get": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Get application progress summary", | |
| "operationId": "getProgressSummary", | |
| "parameters": [ | |
| { | |
| "name": "applicationId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ApplicationProgressResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/{applicationId}/next": { | |
| "get": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Get next question or section", | |
| "operationId": "getNextStep", | |
| "parameters": [ | |
| { | |
| "name": "applicationId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "includeSkipped", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ContentItem" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://sherlock.therealbrokerage.com/api/v1/applications/questions/{questionId}/answered": { | |
| "get": { | |
| "tags": [ | |
| "Application" | |
| ], | |
| "summary": "Get answered question by questionId", | |
| "operationId": "getAnsweredStep", | |
| "parameters": [ | |
| { | |
| "name": "questionId", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Sherlock.ContentItem" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| }, | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yada.therealbrokerage.com/api/v1/comments": { | |
| "put": { | |
| "tags": [ | |
| "comment-controller" | |
| ], | |
| "summary": "Update a comment by providing its container (type and id) and the comment id itself", | |
| "operationId": "updateComment", | |
| "parameters": [ | |
| { | |
| "name": "containerType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION", | |
| "REFERRAL", | |
| "INTERNAL_REFERRAL", | |
| "LISTING", | |
| "CHECKLIST_ITEM", | |
| "DROPBOX", | |
| "REAL", | |
| "OFFICE", | |
| "LOAN", | |
| "AGENT", | |
| "AGENT_DEBT", | |
| "BORROWER", | |
| "MORTGAGE_LEAD", | |
| "APPLICATION", | |
| "CHECKLIST", | |
| "EMAIL", | |
| "COMMENT", | |
| "TEAM", | |
| "OUTGOING_PAYMENT", | |
| "WALLET", | |
| "PAYMENT", | |
| "CREDIT_PROFILE", | |
| "VOICE", | |
| "MLS", | |
| "BOARD", | |
| "USER", | |
| "CONVERSATION", | |
| "MUFASA_CONVERSATION", | |
| "REFERRAL_CENTRAL", | |
| "SIGNATURE_DOCUMENT", | |
| "SIGNATURE_PACKET", | |
| "USER_AGREEMENT", | |
| "CONNECTION", | |
| "TRANSACTION_COORDINATOR_CONNECTION", | |
| "COMMISSION_ADVANCE", | |
| "LEO_DOCUMENT_REVIEW", | |
| "LEO_MATERIAL_REVIEW", | |
| "SURVEY", | |
| "TITLE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "containerId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "commentId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.UpdateCommentBody" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.CommentDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "comment-controller" | |
| ], | |
| "summary": "Post a new comment. Container fields (id and type) are required.", | |
| "operationId": "postComment", | |
| "parameters": [ | |
| { | |
| "name": "containerType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION", | |
| "REFERRAL", | |
| "INTERNAL_REFERRAL", | |
| "LISTING", | |
| "CHECKLIST_ITEM", | |
| "DROPBOX", | |
| "REAL", | |
| "OFFICE", | |
| "LOAN", | |
| "AGENT", | |
| "AGENT_DEBT", | |
| "BORROWER", | |
| "MORTGAGE_LEAD", | |
| "APPLICATION", | |
| "CHECKLIST", | |
| "EMAIL", | |
| "COMMENT", | |
| "TEAM", | |
| "OUTGOING_PAYMENT", | |
| "WALLET", | |
| "PAYMENT", | |
| "CREDIT_PROFILE", | |
| "VOICE", | |
| "MLS", | |
| "BOARD", | |
| "USER", | |
| "CONVERSATION", | |
| "MUFASA_CONVERSATION", | |
| "REFERRAL_CENTRAL", | |
| "SIGNATURE_DOCUMENT", | |
| "SIGNATURE_PACKET", | |
| "USER_AGREEMENT", | |
| "CONNECTION", | |
| "TRANSACTION_COORDINATOR_CONNECTION", | |
| "COMMISSION_ADVANCE", | |
| "LEO_DOCUMENT_REVIEW", | |
| "LEO_MATERIAL_REVIEW", | |
| "SURVEY", | |
| "TITLE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "containerId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "refersToType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION", | |
| "REFERRAL", | |
| "INTERNAL_REFERRAL", | |
| "LISTING", | |
| "CHECKLIST_ITEM", | |
| "DROPBOX", | |
| "REAL", | |
| "OFFICE", | |
| "LOAN", | |
| "AGENT", | |
| "AGENT_DEBT", | |
| "BORROWER", | |
| "MORTGAGE_LEAD", | |
| "APPLICATION", | |
| "CHECKLIST", | |
| "EMAIL", | |
| "COMMENT", | |
| "TEAM", | |
| "OUTGOING_PAYMENT", | |
| "WALLET", | |
| "PAYMENT", | |
| "CREDIT_PROFILE", | |
| "VOICE", | |
| "MLS", | |
| "BOARD", | |
| "USER", | |
| "CONVERSATION", | |
| "MUFASA_CONVERSATION", | |
| "REFERRAL_CENTRAL", | |
| "SIGNATURE_DOCUMENT", | |
| "SIGNATURE_PACKET", | |
| "USER_AGREEMENT", | |
| "CONNECTION", | |
| "TRANSACTION_COORDINATOR_CONNECTION", | |
| "COMMISSION_ADVANCE", | |
| "LEO_DOCUMENT_REVIEW", | |
| "LEO_MATERIAL_REVIEW", | |
| "SURVEY", | |
| "TITLE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "refersToId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "refersToName", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "callerGroupId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "authorType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "default": "USER", | |
| "enum": [ | |
| "USER", | |
| "SYSTEM" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "authorSubType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "AGENT", | |
| "CONTACT", | |
| "CLIENT", | |
| "MUFASA", | |
| "LEO" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "triggerActivity", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "boolean", | |
| "default": true | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.PostCommentBody" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.CommentDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "comment-controller" | |
| ], | |
| "summary": "Delete a comment by providing its container (type and id) and the comment id itself", | |
| "operationId": "deleteComment", | |
| "parameters": [ | |
| { | |
| "name": "containerType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION", | |
| "REFERRAL", | |
| "INTERNAL_REFERRAL", | |
| "LISTING", | |
| "CHECKLIST_ITEM", | |
| "DROPBOX", | |
| "REAL", | |
| "OFFICE", | |
| "LOAN", | |
| "AGENT", | |
| "AGENT_DEBT", | |
| "BORROWER", | |
| "MORTGAGE_LEAD", | |
| "APPLICATION", | |
| "CHECKLIST", | |
| "EMAIL", | |
| "COMMENT", | |
| "TEAM", | |
| "OUTGOING_PAYMENT", | |
| "WALLET", | |
| "PAYMENT", | |
| "CREDIT_PROFILE", | |
| "VOICE", | |
| "MLS", | |
| "BOARD", | |
| "USER", | |
| "CONVERSATION", | |
| "MUFASA_CONVERSATION", | |
| "REFERRAL_CENTRAL", | |
| "SIGNATURE_DOCUMENT", | |
| "SIGNATURE_PACKET", | |
| "USER_AGREEMENT", | |
| "CONNECTION", | |
| "TRANSACTION_COORDINATOR_CONNECTION", | |
| "COMMISSION_ADVANCE", | |
| "LEO_DOCUMENT_REVIEW", | |
| "LEO_MATERIAL_REVIEW", | |
| "SURVEY", | |
| "TITLE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "containerId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "commentId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yada.therealbrokerage.com/api/v1/voice/calls": { | |
| "post": { | |
| "tags": [ | |
| "voice-call-controller" | |
| ], | |
| "summary": "Setup a new voice-call", | |
| "operationId": "createVoiceCall", | |
| "parameters": [ | |
| { | |
| "name": "X-real-app-name", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.CreateVoiceCallRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.VoiceCallDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yada.therealbrokerage.com/api/v1/voice/calls/{id}/sms-dial-number": { | |
| "post": { | |
| "tags": [ | |
| "voice-call-controller" | |
| ], | |
| "summary": "SMS the dial number for the voice-call to the caller", | |
| "operationId": "smsDialNumber", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yada.therealbrokerage.com/api/v1/voice/calls/{id}/feedbacks": { | |
| "post": { | |
| "tags": [ | |
| "voice-feedback-controller" | |
| ], | |
| "summary": "Create or update feedback by user for a given voice-call transcript", | |
| "operationId": "createVoiceFeedback", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "X-real-app-name", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "X-real-app-version", | |
| "in": "header", | |
| "required": false, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.CreateOrUpdateVoiceFeedbackRequest" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.VoiceFeedbackDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yada.therealbrokerage.com/api/v1/latestCommentsByReference": { | |
| "post": { | |
| "tags": [ | |
| "comment-controller" | |
| ], | |
| "summary": "Get the latest comment for each provided Rezen reference entity (such as a Checklist Item). Note the format for the parameters is {TWO-DIGIT-ID}#{UUID}. For example: 'CI#4b7083ba-c858-48e8-99a4-0ba126e47d59' or 'TX#1f516043-42c1-4741-b425-f9b45984c9f3'", | |
| "operationId": "getLatestCommentsByReference", | |
| "parameters": [ | |
| { | |
| "name": "limit", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "maximum": 10, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 1 | |
| } | |
| }, | |
| { | |
| "name": "authorType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "USER", | |
| "SYSTEM" | |
| ] | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Yada.RezenObject" | |
| } | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.LatestCommentsResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yada.therealbrokerage.com/api/v1/inbox/unread": { | |
| "post": { | |
| "tags": [ | |
| "inbox-controller" | |
| ], | |
| "summary": "Mark a given message or all messages for a user + target as unread", | |
| "operationId": "markMessageAsUnread", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "targetType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION", | |
| "REFERRAL", | |
| "INTERNAL_REFERRAL", | |
| "LISTING", | |
| "CHECKLIST_ITEM", | |
| "DROPBOX", | |
| "REAL", | |
| "OFFICE", | |
| "LOAN", | |
| "AGENT", | |
| "AGENT_DEBT", | |
| "BORROWER", | |
| "MORTGAGE_LEAD", | |
| "APPLICATION", | |
| "CHECKLIST", | |
| "EMAIL", | |
| "COMMENT", | |
| "TEAM", | |
| "OUTGOING_PAYMENT", | |
| "WALLET", | |
| "PAYMENT", | |
| "CREDIT_PROFILE", | |
| "VOICE", | |
| "MLS", | |
| "BOARD", | |
| "USER", | |
| "CONVERSATION", | |
| "MUFASA_CONVERSATION", | |
| "REFERRAL_CENTRAL", | |
| "SIGNATURE_DOCUMENT", | |
| "SIGNATURE_PACKET", | |
| "USER_AGREEMENT", | |
| "CONNECTION", | |
| "TRANSACTION_COORDINATOR_CONNECTION", | |
| "COMMISSION_ADVANCE", | |
| "LEO_DOCUMENT_REVIEW", | |
| "LEO_MATERIAL_REVIEW", | |
| "SURVEY", | |
| "TITLE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "targetId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "202": { | |
| "description": "Accepted" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yada.therealbrokerage.com/api/v1/inbox/read": { | |
| "post": { | |
| "tags": [ | |
| "inbox-controller" | |
| ], | |
| "summary": "Mark a given message or all messages for a user + target as read", | |
| "operationId": "markMessageAsRead", | |
| "parameters": [ | |
| { | |
| "name": "userId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "targetType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION", | |
| "REFERRAL", | |
| "INTERNAL_REFERRAL", | |
| "LISTING", | |
| "CHECKLIST_ITEM", | |
| "DROPBOX", | |
| "REAL", | |
| "OFFICE", | |
| "LOAN", | |
| "AGENT", | |
| "AGENT_DEBT", | |
| "BORROWER", | |
| "MORTGAGE_LEAD", | |
| "APPLICATION", | |
| "CHECKLIST", | |
| "EMAIL", | |
| "COMMENT", | |
| "TEAM", | |
| "OUTGOING_PAYMENT", | |
| "WALLET", | |
| "PAYMENT", | |
| "CREDIT_PROFILE", | |
| "VOICE", | |
| "MLS", | |
| "BOARD", | |
| "USER", | |
| "CONVERSATION", | |
| "MUFASA_CONVERSATION", | |
| "REFERRAL_CENTRAL", | |
| "SIGNATURE_DOCUMENT", | |
| "SIGNATURE_PACKET", | |
| "USER_AGREEMENT", | |
| "CONNECTION", | |
| "TRANSACTION_COORDINATOR_CONNECTION", | |
| "COMMISSION_ADVANCE", | |
| "LEO_DOCUMENT_REVIEW", | |
| "LEO_MATERIAL_REVIEW", | |
| "SURVEY", | |
| "TITLE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "targetId", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "202": { | |
| "description": "Accepted" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yada.therealbrokerage.com/api/v1/conversations": { | |
| "get": { | |
| "tags": [ | |
| "Conversations" | |
| ], | |
| "summary": "Get conversations", | |
| "operationId": "getConversations", | |
| "parameters": [ | |
| { | |
| "name": "pageNumber", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 0, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| } | |
| }, | |
| { | |
| "name": "pageSize", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "minimum": 1, | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 20 | |
| } | |
| }, | |
| { | |
| "name": "sortDirection", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "default": "DESC", | |
| "enum": [ | |
| "ASC", | |
| "DESC" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "sortBy", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "enum": [ | |
| "CREATED_AT", | |
| "UPDATED_AT" | |
| ] | |
| }, | |
| "default": [ | |
| "CREATED_AT" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "withUser", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "default": [] | |
| } | |
| }, | |
| { | |
| "name": "withGroup", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "uniqueItems": true, | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "default": [] | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.GenericSearchResponseConversationDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Conversations" | |
| ], | |
| "summary": "Create or find existing conversation", | |
| "description": "One of the conversation members should be the caller or a group they are part of. If a conversation with the requested members already exists, the existing conversation will be returned.", | |
| "operationId": "createConversation", | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.CreateConversation" | |
| } | |
| } | |
| }, | |
| "required": true | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "*/*": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Yada.ConversationDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "bearer-key": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "https://yada.therealbrokerage.com/api/v1/comments/upload-media": { | |
| "post": { | |
| "tags": [ | |
| "comment-controller" | |
| ], | |
| "summary": "Upload a media-file in a comment.", | |
| "operationId": "uploadMedia", | |
| "parameters": [ | |
| { | |
| "name": "containerType", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION", | |
| "REFERRAL", | |
| "INTERNAL_REFERRAL", | |
| "LISTING", | |
| "CHECKLIST_ITEM", | |
| "DROPBOX", | |
| "REAL", | |
| "OFFICE", | |
| "LOAN", | |
| "AGENT", | |
| "AGENT_DEBT", | |
| "BORROWER", | |
| "MORTGAGE_LEAD", | |
| "APPLICATION", | |
| "CHECKLIST", | |
| "EMAIL", | |
| "COMMENT", | |
| "TEAM", | |
| "OUTGOING_PAYMENT", | |
| "WALLET", | |
| "PAYMENT", | |
| "CREDIT_PROFILE", | |
| "VOICE", | |
| "MLS", | |
| "BOARD", | |
| "USER", | |
| "CONVERSATION", | |
| "MUFASA_CONVERSATION", | |
| "REFERRAL_CENTRAL", | |
| "SIGNATURE_DOCUMENT", | |
| "SIGNATURE_PACKET", | |
| "USER_AGREEMENT", | |
| "CONNECTION", | |
| "TRANSACTION_COORDINATOR_CONNECTION", | |
| "COMMISSION_ADVANCE", | |
| "LEO_DOCUMENT_REVIEW", | |
| "LEO_MATERIAL_REVIEW", | |
| "SURVEY", | |
| "TITLE" | |
| ] | |
| } | |
| }, | |
| { | |
| "name": "containerId", | |
| "in": "query", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "refersToType", | |
| "in": "query", | |
| "required": false, | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "TRANSACTION", | |
| "REFERRAL", | |
| "INTERNAL_REFERRAL", | |
| "LISTING", | |
| "CHECKLIST_ITEM", | |
| "DROPBOX", | |
| "REAL", | |
| "OFFICE", | |
| "LOAN", | |
| "AGENT", | |
| "AGENT_DEBT", | |
| "BORROWER", | |
| "MORTGAGE_LEAD", | |
| "APPLICATION", | |
| "CHECKLIST", | |
| "EMAIL", | |
| "COMMENT", | |
| "TEAM", | |
| "OUTGOING_PAYMENT", | |
| "WALLET", | |
| "PAYMENT", | |
| "CREDIT_PROFILE", | |
| "VOICE", | |
| "MLS", | |
| "BOARD", | |
| "USER", | |
| "CONVERSATION", | |
| "MUFASA_CONVERSATION", | |
| "REFERRAL_CENTRAL", | |
| "SIGNATURE_DOCUMENT", | |
| "SIGNATURE_PACKET", | |
| "USER_AGREEMENT", | |
| "CONNECTION", | |
| "TRANSACTION_COO |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment