xfloor-memory-sdk 1.0.0

Floor Memory

xfloor-memory-sdk

The set APIs are used to develop Floor pds which can be used as their personal assistants.

This set of APIs are divided into two parts.

• Memory and
• Registration.

The developer has two ways of using the APIs for the app development. Developer can choose to the Registration APIs for using the existing xfloor infracture or can implement custom Registration process. In the case of custom registration process, the developer is bound to provide proper authentication mechanisms and then send the user information to xlfoor.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.18.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://xfloor.ai/ipomo/blog1551084548304/

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import xfloor_memory_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import xfloor_memory_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import xfloor_memory_sdk
from xfloor_memory_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://appfloor.in
# See configuration.py for a list of all supported configuration parameters.
configuration = xfloor_memory_sdk.Configuration(
    host = "https://appfloor.in"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearer
configuration = xfloor_memory_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with xfloor_memory_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = xfloor_memory_sdk.DefaultApi(api_client)
    new_email_id = 'new_email_id_example' # str | New Email ID
    activation_code = 'activation_code_example' # str | Validation code

    try:
        # Change email ID
        api_response = api_instance.change_email(new_email_id, activation_code)
        print("The response of DefaultApi->change_email:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->change_email: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://appfloor.in

Class	Method	HTTP request	Description
DefaultApi	change_email	POST /auth-service/change/email	Change email ID
DefaultApi	change_mobile_number	POST /auth-service/change/mobile	Change Mobile number
DefaultApi	change_password	POST /auth-service/change/password	Change Password
DefaultApi	make_floor_private	POST /api/memory/make/floor/private	Make floor Private
DefaultApi	make_floor_public	POST /api/memory/make/floor/public	Make floor public
DefaultApi	register_external_user_identity	POST /memory/identity/external-user	External User Registration
DefaultApi	rename_floor	POST /api/memory/change/floor/id	Rename floor
DefaultApi	send_sign_in_validation_code	POST /auth-service/send/sign/in/validation/code	Send Sign-In Validation Code (OTP)
DefaultApi	send_validation_code	POST /auth-service/send/validation/code	Send Validation code
DefaultApi	sign_in_with_email	POST /auth-service/sign/in/with/email	Sign In with email ID
DefaultApi	sign_in_with_mobile_number	POST /auth-service/sign/in/with/mobile/number	Sign In with Mobile number
DefaultApi	sign_up	POST /auth-service/sign/up	Sign Up
DefaultApi	validate_code	POST /auth-service/validate/activation/code	Validation
EditFloorApi	edit_floor	POST /api/memory/edit/floor/{floor_id}	Edit floor
EventApi	event	POST /api/memory/events	Create Event (Post Content)
GetFloorInformationApi	get_floor_information	GET /api/memory/floor/info/{floor_id}	Basic information of a floor
GetRecentEventsApi	get_recent_events	GET /api/memory/recent/events	Recent Events
QueryApi	query	POST /agent/memory/query	Query (Primary API)

Documentation For Models

• BlockDetails
• ChangePassword200Response
• EditFloor400Response
• EditFloor400ResponseError
• Event400Response
• Event400ResponseError
• EventResponse
• FloorInfo
• GetFloorInformation200Response
• GetRecentEvents200Response
• GetRecentEvents200ResponseItemsInner
• GetRecentEvents200ResponseItemsInnerAuthor
• GetRecentEvents400Response
• GetRecentEvents400ResponseError
• Media
• Model400ErrorCode
• Query422Response
• Query422ResponseError
• QueryRequest
• QueryRequestFilters
• QueryResponse
• QueryResponseItemsInner
• SendSignInValidationCode200Response
• SendSignInValidationCode400Response
• SendValidationCode200Response
• SendValidationCodeRequest
• SignInWithEmail200Response
• SignInWithEmail200ResponseProfile
• SignInWithEmail200ResponseProfileAvatar
• SignUp200Response
• SignUpResponse
• UserDetails
• ValidateCode400Response
• ValidateCode400ResponseError
• ValidateCode412Response
• ValidateCodeRequest

Documentation For Authorization

Authentication schemes defined for the API:

bearer

• Type: Bearer authentication

Author

[e-mail]