Skip to main content

Python wrapper for the RockyRoad API

Project description

RockyRoad

This package provides a Python wrapper for the RockyRoad API.

RockyRoad is a part of the PyPi repository and can be installed via

pip install RockyRoad

export OCP_APIM_SUBSCRIPTION_KEY="INSERT_YOUR_SUBSCRIPTION_KEY"


Usage Examples - Data Services:

    from rockyroad.rockyroad import build

    dataservice = build(serviceName="data-services", version="v1", base_url='INSERT_URL_FOR_API')

    api_response = dataservice.helloWorld().list()

    dataservice.docs().swagger().content
    dataservice.docs().redocs().content
    dataservice.docs().openapi()

    api_response = dataservice.alerts().requests().list()
    api_response = dataservice.alerts().requests().list(creator_email='user@acme.com')
    api_response = dataservice.alerts().requests().insert(new_alert_request_json)
    api_response = dataservice.alerts().requests().delete(brand=brand, alert_request_id=alert_request_id)

    api_response = dataservice.alerts().reports().list()
    api_response = dataservice.alerts().reports().list(creator_email='user@acme.com')

    api_response = dataservice.machines().utilData().list(brand=brand, time_period='today')
    api_response = dataservice.machines().utilData().stats().list()

    api_response = dataservice.dealers().list()
    api_response = dataservice.customers().list(dealer_name=dealer_name)

    api_response = dataservice.accounts().list()
    api_response = dataservice.accounts().list(account="c123")
    api_response = dataservice.accounts().list(account_association_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.accounts().insert(new_account=new_account)
    api_response = dataservice.accounts().update(account=update_account)
    api_response = dataservice.accounts().delete(account="d123")

    api_response = dataservice.accounts().set_is_dealer(account="d123", is_dealer=True)
    api_response = dataservice.accounts().assign_dealer(customer_account="c123", dealer_account="d123", is_default_dealer=True, dealer_internal_account="abc")
    api_response = dataservice.accounts().assign_dealer(customer_account="c123", dealer_account="d123")
    api_response = dataservice.accounts().unassign_dealer(customer_account="c123", dealer_account="d123")

    api_response = dataservice.accounts().contacts().list(account=account)
    api_response = dataservice.accounts().contacts().list(account=account, include_dealer_contacts=True)
    api_response = dataservice.accounts().contacts().list(account_uid=account_uid)
    api_response = dataservice.accounts().contacts().list(account_contact_uid=account_contact_uid)
    api_response = dataservice.accounts().contacts().insert(new_account_contact=new_account_contact)
    api_response = dataservice.accounts().contacts().update(account_contact=account_contact)
    api_response = dataservice.accounts().contacts().delete(account_contact_uid="123e4567-e89b-12d3-a456-426614174000")

    api_response = dataservice.accounts().customers().list()
    api_response = dataservice.accounts().customers().list(dealer_account="D123")
    api_response = dataservice.accounts().customers().dealer_provided_information().list(dealer_account=dealer_account, customer_account=customer_account)
    api_response = dataservice.accounts().customers().dealer_provided_information().update(dealer_provided_information=dealer_provided_information)
    
    api_response = dataservice.accounts().dealers().list()
    api_response = dataservice.accounts().dealers().list(customer_account="A123")

    api_response = dataservice.apbs().list()
    api_response = dataservice.apbs().list(apb_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.apbs().list(brand="brand", model="model", serial="1234")
    api_response = dataservice.apbs().insert(new_apb=new_apb)
    api_response = dataservice.apbs().delete(apb_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.apbs().update(apb=updated_apb)

    api_response = dataservice.apbs().status().list(apb_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.apbs().status().insert(new_apb_status=new_apb_status)
    api_response = dataservice.apbs().status().delete(apb_status_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.apbs().status().update(apb_status=updated_apb_status)

    api_response = dataservice.apbs().requests().list(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.apbs().requests().insert(new_apb_request=new_apb_request)
    api_response = dataservice.apbs().requests().delete(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.apbs().requests().update(apb_request=updated_apb_request)

    api_response = dataservice.machines().catalog().list()
    api_response = dataservice.machines().catalog().list(machine_catalog_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.machines().catalog().insert(new_machine_catalog=new_machine_catalog)
    api_response = dataservice.machines().catalog().delete(machine_catalog_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.machines().catalog().update(machine_catalog=machine_catalog)
    api_response = dataservice.machines().assign_machines_to_default_dealer(customer_account="c123", ignore_machines_with_dealer=True)

    api_response = dataservice.machines().list()
    api_response = dataservice.warranties().rates().list(include_util_data=True)
    api_response = dataservice.machines().list(account="a123")
    api_response = dataservice.machines().list(account_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.machines().list(account="a123", dealer_account="d123")
    api_response = dataservice.machines().list(account_uid="123e4567-e89b-12d3-a456-426614174000", dealer_account_uid="07cc67f4-45d6-494b-adac-09b5cbc7e2b5")
    api_response = dataservice.machines().list(brand="brand", model="model", serial="1234")
    api_response = dataservice.machines().insert(new_machine=new_machine)
    api_response = dataservice.machines().delete(machine_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.machines().update(machine=updated_machine)

    api_response = dataservice.machines().serials().list()
    api_response = dataservice.machines().models().list()
    api_response = dataservice.machines().brands().list()
    api_response = dataservice.machines().brands().list(model=model)
    api_response = dataservice.machines().product_types().list()

    api_response = dataservice.machines().telematics().list()
    api_response = dataservice.machines().telematics().list(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.machines().telematics().list(machine_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.machines().telematics().insert(telematics=telematics)
    api_response = dataservice.machines().telematics().update(telematics=telematics)
    api_response = dataservice.machines().telematics().delete(uid="123e4567-e89b-12d3-a456-426614174000")

    api_response = dataservice.machines().logs().list()
    api_response = dataservice.machines().logs().list(machine_log_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.machines().logs().list(machine_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.machines().logs().list(model=model, serial=serial)
    api_response = dataservice.machines().logs().insert(machine_log=machine_log)
    api_response = dataservice.machines().logs().delete(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.machines().logs().update(log=log)

    api_response = dataservice.parts().list()
    api_response = dataservice.parts().list(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.parts().list(partName="abc")
    api_response = dataservice.parts().list(partNumber="acme-01")
    api_response = dataservice.parts().list(isKit=True)
    api_response = dataservice.parts().list(isKitPart=True)
    api_response = dataservice.parts().list(isKit=True, isKitPart=False)
    api_response = dataservice.parts().insert(part=part)
    api_response = dataservice.parts().update(part=part)
    api_response = dataservice.parts().delete(uid="123e4567-e89b-12d3-a456-426614174000")

    api_response = dataservice.parts().kits().list(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.parts().kits().list(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.parts().kits().list(kitPartNumber="acme-01")
    api_response = dataservice.parts().kits().list(partNumber="acme-01")
    api_response = dataservice.parts().kits().insert(kit=kit)
    api_response = dataservice.parts().kits().update(kit=kit)
    api_response = dataservice.parts().kits().delete(uid="123e4567-e89b-12d3-a456-426614174000")

    api_response = dataservice.services().maintenanceIntervals().list()
    api_response = dataservice.services().maintenanceIntervals().list(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.services().maintenanceIntervals().list(hours=250, brand=brand, model=model, serial=serial)
    api_response = dataservice.services().maintenanceIntervals().insert(maintenanceInterval=maintenanceInterval)
    api_response = dataservice.services().maintenanceIntervals().update(maintenanceInterval=maintenanceInterval)
    api_response = dataservice.services().maintenanceIntervals().delete(uid="123e4567-e89b-12d3-a456-426614174000")

    api_response = dataservice.services().emails().resetServiceDueHours(email_fields=email_fields)
    api_response = dataservice.services().emails().create(email_template=email_template, email_fields=email_fields)

    api_response = dataservice.summaries().machineParts().list()
    api_response = dataservice.summaries().machineParts().list(account="a123")
    api_response = dataservice.summaries().machineParts().list(account_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.summaries().machineParts().list(account="a123", dealer_account="d123")
    api_response = dataservice.summaries().machineParts().list(account_uid="123e4567-e89b-12d3-a456-426614174000", dealer_account_uid="07cc67f4-45d6-494b-adac-09b5cbc7e2b5")
    api_response = dataservice.summaries().machineParts().list(brand="brand", model="model", serial="1234")

    api_response = dataservice.summaries().machineParts().list()
    api_response = dataservice.summaries().machineParts().list(account="a123")
    api_response = dataservice.summaries().machineParts().list(account_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.summaries().machineParts().list(account="a123", dealer_account="d123")
    api_response = dataservice.summaries().machineParts().list(account_uid="123e4567-e89b-12d3-a456-426614174000", dealer_account_uid="07cc67f4-45d6-494b-adac-09b5cbc7e2b5")
    api_response = dataservice.summaries().machineParts().list(model="model", serial="1234")

    api_response = dataservice.warranties().creditRequests().list()
    api_response = dataservice.warranties().creditRequests().list(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.warranties().creditRequests().list(dealer_account="d123)
    api_response = dataservice.warranties().creditRequests().insert(creditRequest=creditRequest)
    api_response = dataservice.warranties().creditRequests().addFile(uid="123e4567-e89b-12d3-a456-426614174000", file=file)
    api_response = dataservice.warranties().creditRequests().listFiles(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.warranties().creditRequests().downloadFile(uid="123e4567-e89b-12d3-a456-426614174000", filename=filename)
    api_response = dataservice.warranties().creditRequests().update(creditRequest=creditRequest)
    api_response = dataservice.warranties().creditRequests().delete(uid="123e4567-e89b-12d3-a456-426614174000")

    api_response = dataservice.warranties().creditRequests().logs().list()
    api_response = dataservice.warranties().creditRequests().logs().list(warranty_log_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.warranties().creditRequests().logs().list(warranty_credit_request_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.warranties().creditRequests().logs().insert(warranty_log=warranty_log)
    api_response = dataservice.warranties().creditRequests().logs().delete(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.warranties().creditRequests().logs().update(log=log)

    api_response = dataservice.warranties().rates().list()
    api_response = dataservice.warranties().rates().list(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.warranties().rates().list(dealer_account="acme-01")
    api_response = dataservice.warranties().rates().list(dealer_account_uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.warranties().rates().insert(warrantyRates=warrantyRates)
    api_response = dataservice.warranties().rates().update(warrantyRates=warrantyRates)
    api_response = dataservice.warranties().rates().delete(uid="123e4567-e89b-12d3-a456-426614174000")
    api_response = dataservice.warranties().emails().create(emailRequest=emailRequest)
    api_response = dataservice.warranties().emails().create(useLocalTemplate=True, emailRequest=emailRequest)

    api_response = dataservice.inspections().reports().insert(inspectionReport=inspectionReport)


Usage Examples - Email Services:

    from rockyroad.rockyroad import build

    emailservice = build(serviceName="email-services", version="v1", base_url='INSERT_URL_FOR_API')

    email_message = {
        "recipient": "someone@acme.com",
        "subject": "Sending Email Message via API",
        "html_message": "This email send via the API!",
        "text_message": "This email send via the API!",
        }

    api_response = emailservice.emails().send(email_message_json)
    print(api_response)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

RockyRoad-0.0.84-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file RockyRoad-0.0.84-py3-none-any.whl.

File metadata

  • Download URL: RockyRoad-0.0.84-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for RockyRoad-0.0.84-py3-none-any.whl
Algorithm Hash digest
SHA256 746222c6cd3b69c560a0c3450c18ebdb967501d31b23862d23f6f2d545496ee7
MD5 b42c3fe46996812d10f5c7a2eab8e8b0
BLAKE2b-256 f75c7646173c84c4b3959888a2b5fd2a44ba8ff04d928e7afadcc78cce21a1d0

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page