floke-cdk-client 1.0.0

Floke Connector API Client

floke-cdk-client

API for building Floke-compliant connectors

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://github.com/hoshii-ai/floke

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

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 floke_cdk_client 

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 floke_cdk_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import floke_cdk_client
from floke_cdk_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apiKeyAuth
configuration = floke_cdk_client.Configuration()
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = floke_cdk_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: oauth2Auth
configuration = floke_cdk_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = floke_cdk_client.AuthenticationServiceApi(floke_cdk_client.ApiClient(configuration))
body = floke_cdk_client.AuthenticateRequest() # AuthenticateRequest | 

try:
    # Authenticate with the target system
    api_response = api_instance.authentication_service_authenticate(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationServiceApi->authentication_service_authenticate: %s\n" % e)

# Configure API key authorization: apiKeyAuth
configuration = floke_cdk_client.Configuration()
configuration.api_key['X-API-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-API-Key'] = 'Bearer'# Configure HTTP basic authorization: basicAuth
configuration = floke_cdk_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: oauth2Auth
configuration = floke_cdk_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = floke_cdk_client.AuthenticationServiceApi(floke_cdk_client.ApiClient(configuration))
body = floke_cdk_client.RefreshTokenRequest() # RefreshTokenRequest | 

try:
    # Refresh an authentication token
    api_response = api_instance.authentication_service_refresh_token(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationServiceApi->authentication_service_refresh_token: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://CONNECTOR_INSTANCE_UID.connectors.floke.ai/

Class	Method	HTTP request	Description
AuthenticationServiceApi	authentication_service_authenticate	POST /api/v1/auth/authenticate	Authenticate with the target system
AuthenticationServiceApi	authentication_service_refresh_token	POST /api/v1/auth/refresh	Refresh an authentication token
BusinessContactServiceApi	business_contact_service_create_business_contact	POST /api/v1/business_contacts	Create a new business contact
BusinessContactServiceApi	business_contact_service_delete_business_contact	DELETE /api/v1/business_contacts/{id}	Delete a business contact
BusinessContactServiceApi	business_contact_service_get_business_contact	GET /api/v1/business_contacts/{id}	Get a business contact by ID
BusinessContactServiceApi	business_contact_service_list_business_contacts	GET /api/v1/business_contacts	List business contacts
BusinessContactServiceApi	business_contact_service_update_business_contact	PUT /api/v1/business_contacts/{business_contact.id}	Update a business contact
BusinessPartnerServiceApi	business_partner_service_create_business_partner	POST /api/v1/business_partners	Create a new business partner
BusinessPartnerServiceApi	business_partner_service_delete_business_partner	DELETE /api/v1/business_partners/{id}	Delete a business partner
BusinessPartnerServiceApi	business_partner_service_get_business_partner	GET /api/v1/business_partners/{id}	Get a business partner by ID
BusinessPartnerServiceApi	business_partner_service_list_business_partners	GET /api/v1/business_partners	List business partners
BusinessPartnerServiceApi	business_partner_service_update_business_partner	PUT /api/v1/business_partners/{business_partner.id}	Update a business partner
ItemServiceApi	item_service_create_item	POST /api/v1/items	Create a new item
ItemServiceApi	item_service_delete_item	DELETE /api/v1/items/{id}	Delete an item
ItemServiceApi	item_service_get_item	GET /api/v1/items/{id}	Get an item by ID
ItemServiceApi	item_service_list_items	GET /api/v1/items	List items
ItemServiceApi	item_service_update_item	PUT /api/v1/items/{item.id}	Update an item
MetadataServiceApi	metadata_service_get_feature_flags	GET /api/v1/metadata/feature_flags	Get feature flags
MetadataServiceApi	metadata_service_get_metadata	GET /api/v1/metadata	Get all metadata
MetadataServiceApi	metadata_service_get_versions	GET /api/v1/metadata/versions	Get versions
PackingUnitServiceApi	packing_unit_service_create_packing_unit	POST /api/v1/packing_units	Create a new packing unit
PackingUnitServiceApi	packing_unit_service_delete_packing_unit	DELETE /api/v1/packing_units/{id}	Delete a packing unit
PackingUnitServiceApi	packing_unit_service_get_packing_unit	GET /api/v1/packing_units/{id}	Get a packing unit by ID
PackingUnitServiceApi	packing_unit_service_list_packing_units	GET /api/v1/packing_units	List packing units
PackingUnitServiceApi	packing_unit_service_update_packing_unit	PUT /api/v1/packing_units/{packing_unit.id}	Update a packing unit
PriceServiceApi	price_service_create_price	POST /api/v1/prices	Create a new price
PriceServiceApi	price_service_delete_price	DELETE /api/v1/prices/{id}	Delete a price
PriceServiceApi	price_service_get_item_price	GET /api/v1/prices/items/{id}	Get an item's price
PriceServiceApi	price_service_get_price	GET /api/v1/prices/{id}	Get a price by ID
PriceServiceApi	price_service_list_prices	GET /api/v1/prices	List prices
PriceServiceApi	price_service_update_price	PUT /api/v1/prices/{price.id}	Update a price
RouteServiceApi	route_service_create_route	POST /api/v1/logistics/routes	Create a new route
RouteServiceApi	route_service_delete_route	DELETE /api/v1/logistics/routes/{id}	Delete a route
RouteServiceApi	route_service_get_route	GET /api/v1/logistics/routes/{id}	Get a route by ID
RouteServiceApi	route_service_list_routes	GET /api/v1/logistics/routes	List routes
RouteServiceApi	route_service_update_route	PUT /api/v1/logistics/routes/{route.id}	Update a route
SalesOrderServiceApi	sales_order_service_create_sales_order	POST /api/v1/sales_orders	Create a new sales order
SalesOrderServiceApi	sales_order_service_delete_sales_order	DELETE /api/v1/sales_orders/{id}	Delete a sales order
SalesOrderServiceApi	sales_order_service_get_sales_order	GET /api/v1/sales_orders/{id}	Get a sales order by ID
SalesOrderServiceApi	sales_order_service_list_sales_orders	GET /api/v1/sales_orders	List sales orders
SalesOrderServiceApi	sales_order_service_update_sales_order	PUT /api/v1/sales_orders/{sales_order.id}	Update a sales order
SalesQuotationServiceApi	sales_quotation_service_convert_quotation_to_order	POST /api/v1/sales_quotations/{id}/convert	Convert quotation to order
SalesQuotationServiceApi	sales_quotation_service_create_sales_quotation	POST /api/v1/sales_quotations	Create a new sales quotation
SalesQuotationServiceApi	sales_quotation_service_delete_sales_quotation	DELETE /api/v1/sales_quotations/{id}	Delete a sales quotation
SalesQuotationServiceApi	sales_quotation_service_get_sales_quotation	GET /api/v1/sales_quotations/{id}	Get a sales quotation by ID
SalesQuotationServiceApi	sales_quotation_service_list_sales_quotations	GET /api/v1/sales_quotations	List sales quotations
SalesQuotationServiceApi	sales_quotation_service_update_sales_quotation	PUT /api/v1/sales_quotations/{sales_quotation.id}	Update a sales quotation
StockLevelServiceApi	stock_level_service_create_stock_levels	POST /api/v1/stock-levels	Create a new stock level
StockLevelServiceApi	stock_level_service_delete_stock_level	DELETE /api/v1/stock-levels/{id}	Delete a stock level
StockLevelServiceApi	stock_level_service_get_stock_level	GET /api/v1/stock-levels/{id}	Get a stock level by ID
StockLevelServiceApi	stock_level_service_get_stock_levels_by_item_id	GET /api/v1/stock-levels/items/{id}	Get an item's stock levels
StockLevelServiceApi	stock_level_service_list_stock_levels	GET /api/v1/stock-levels	List stock levels
StockLevelServiceApi	stock_level_service_update_stock_level	PUT /api/v1/stock-levels/{id}	Update a stock level
UnitOfMeasureServiceApi	unit_of_measure_service_create_unit_of_measure	POST /api/v1/unit_of_measures	Create a new unit of measure
UnitOfMeasureServiceApi	unit_of_measure_service_delete_unit_of_measure	DELETE /api/v1/unit_of_measures/{id}	Delete a unit of measure
UnitOfMeasureServiceApi	unit_of_measure_service_get_unit_of_measure	GET /api/v1/unit_of_measures/{id}	Get a unit of measure by ID
UnitOfMeasureServiceApi	unit_of_measure_service_list_unit_of_measures	GET /api/v1/unit_of_measures	List units of measure
UnitOfMeasureServiceApi	unit_of_measure_service_update_unit_of_measure	PUT /api/v1/unit_of_measures/{uom.id}	Update a unit of measure

Documentation For Models

• Address
• AllOfAuthenticateRequestCustom
• ApiKeyCredentials
• AuditInfo
• AuthToken
• AuthenticateRequest
• AuthenticateResponse
• BaseContext
• BasicAuthCredentials
• BusinessContact
• BusinessPartner
• ConvertQuotationToOrderRequest
• ConvertQuotationToOrderResponse
• CreateBusinessContactRequest
• CreateBusinessContactResponse
• CreateBusinessPartnerRequest
• CreateBusinessPartnerResponse
• CreateItemRequest
• CreateItemResponse
• CreatePackingUnitRequest
• CreatePackingUnitResponse
• CreatePriceRequest
• CreatePriceResponse
• CreateRouteRequest
• CreateRouteResponse
• CreateSalesOrderRequest
• CreateSalesOrderRequestOptions
• CreateSalesOrderResponse
• CreateSalesQuotationRequest
• CreateSalesQuotationResponse
• CreateStockLevelsRequest
• CreateStockLevelsResponse
• CreateUnitOfMeasureRequest
• CreateUnitOfMeasureResponse
• CurrencyAmount
• CustomCredentials
• DeleteBusinessContactResponse
• DeleteBusinessPartnerResponse
• DeleteItemResponse
• DeletePackingUnitResponse
• DeletePriceResponse
• DeleteRouteResponse
• DeleteSalesOrderResponse
• DeleteSalesQuotationResponse
• DeleteStockLevelResponse
• DeleteUnitOfMeasureResponse
• GetBusinessContactResponse
• GetBusinessPartnerResponse
• GetFeatureFlagsResponse
• GetItemPriceResponse
• GetItemResponse
• GetMetadataResponse
• GetPackingUnitResponse
• GetPriceResponse
• GetRouteResponse
• GetSalesOrderResponse
• GetSalesQuotationResponse
• GetStockLevelResponse
• GetStockLevelsByItemIdResponse
• GetUnitOfMeasureResponse
• GetVersionsResponse
• GoogleProtobufAny
• Item
• ItemPackingUnit
• ItemPackingUnits
• ItemUnitOfMeasure
• ItemUnitOfMeasures
• JwtCredentials
• ListBusinessContactsResponse
• ListBusinessPartnersResponse
• ListItemsResponse
• ListPackingUnitsResponse
• ListPricesResponse
• ListRoutesResponse
• ListSalesOrdersResponse
• ListSalesQuotationsResponse
• ListStockLevelsResponse
• ListUnitOfMeasuresResponse
• OAuth2Credentials
• PackingUnit
• PaginationResponse
• PhoneNumber
• Price
• RefreshTokenRequest
• RefreshTokenResponse
• RequestContext
• Route
• SalesAddress
• SalesBusinessContact
• SalesBusinessPartner
• SalesOrder
• SalesOrderLine
• SalesQuotation
• SalesQuotationLine
• SemanticVersion
• Status
• StockLevel
• UnitOfMeasure
• UpdateBusinessContactRequest
• UpdateBusinessContactResponse
• UpdateBusinessPartnerRequest
• UpdateBusinessPartnerResponse
• UpdateItemRequest
• UpdateItemResponse
• UpdatePackingUnitRequest
• UpdatePackingUnitResponse
• UpdatePriceRequest
• UpdatePriceResponse
• UpdateRouteRequest
• UpdateRouteResponse
• UpdateSalesOrderRequest
• UpdateSalesOrderResponse
• UpdateSalesQuotationRequest
• UpdateSalesQuotationResponse
• UpdateStockLevelRequest
• UpdateStockLevelResponse
• UpdateUnitOfMeasureRequest
• UpdateUnitOfMeasureResponse

Documentation For Authorization

apiKeyAuth

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header

basicAuth

• Type: HTTP basic authentication

bearerAuth

oauth2Auth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://CONNECTOR_INSTANCE_UID.connectors.floke.ai/api/v1/auth/oauth2/authorize
• Scopes:

Author

[e-mail]