From 904bb33184794be04cb8cbcfb3e1a388d0f0b6eb Mon Sep 17 00:00:00 2001 From: Su Gi Date: Tue, 2 Jan 2024 19:22:10 -0800 Subject: [PATCH 01/10] Create base function --- snipeit/Assets.py | 270 +++++++++++++++++++++++++--------------------- 1 file changed, 150 insertions(+), 120 deletions(-) diff --git a/snipeit/Assets.py b/snipeit/Assets.py index 416d4a3..0a9d28f 100644 --- a/snipeit/Assets.py +++ b/snipeit/Assets.py @@ -28,105 +28,122 @@ def __init__(self): def get(self, server, token, limit=None, order='asc', offset=None): """Get list of assets - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API offset {string} -- Starting offset to get the data - + Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) order {string} -- Display order of data (asc / desc default:{asc}) - + Returns: [string] -- List of assets from the server, in JSON formatted """ if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order) + self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( + str(limit), order) else: self.uri = '/api/v1/hardware?order={0}'.format(order) if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + self.uri = self.uri + '&offset={0}'.format(str(offset)) + self.server = server + self.uri headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content - #return json.dumps(results.json(),indent=4, separators=(',', ':')) + # return json.dumps(results.json(),indent=4, separators=(',', ':')) + + def createBaseRequest(self, server, base_uri, token, limit=None, offset=None): + """Get list of assets - def search(self, server, token, limit=None, order='asc', keyword=None, offset=None): - """Get list of assets based on search keyword - Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API offset {string} -- Starting offset to get the data - + Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) order {string} -- Display order of data (asc / desc default:{asc}) - + Returns: - string -- List of assets in JSON format. + [string] -- List of assets from the server, in JSON format """ - if keyword is None: - keyword = "" - if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order) - else: - self.uri = '/api/v1/hardware?order={0}'.format(order) + self.uri = base_uri + '&limit={0}'.format(str(limit)) if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + '&search=' + keyword + self.uri = base_uri + '&offset={0}'.format(str(offset)) + + self.server = server + self.uri headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content - + + def get(self, server, token, limit=None, order='asc', offset=None): + base_uri = '/api/v1/hardware?order={0}'.format(order) + return self.createBaseRequest(self, server, base_uri, token, limit, offset) + + def search(self, server, token, limit=None, order='asc', keyword=None, offset=None): + """Get list of assets based on search keyword + + Arguments: + keyword {string} -- search terms + """ + if keyword is None: + keyword = '' + + uri = '/api/v1/hardware?order={0}'.format(order) + uri = uri + '&search=' + keyword + + return self.createBaseRequest(self, server, uri, token, limit, offset) + def getAssetsByModel(self, server, token, modelID, limit=None, order='asc', offset=None): """Get list of assets - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API - modelID {string} -- Model ID to be limited to - offset {string} -- Starting offset to get the data - + modelID {string} -- Model ID to be limited to + offset {string} -- Starting offset to get the data + Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) order {string} -- Display order of data (asc / desc default:{asc}) - + Returns: [string] -- List of assets from the server, in JSON formatted """ if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order) + self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( + str(limit), order) else: self.uri = '/api/v1/hardware?order={0}'.format(order) if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + self.uri = self.uri + '&offset={0}'.format(str(offset)) + self.server = server + self.uri headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content def getAssetsByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None): """Get list of assets - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API - categoryID {string} -- Category ID to be limited to - offset {string} -- Starting offset to get the data - + categoryID {string} -- Category ID to be limited to + offset {string} -- Starting offset to get the data + Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) order {string} -- Display order of data (asc / desc default:{asc}) - + Returns: [string] -- List of assets from the server, in JSON formatted """ if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order) + self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( + str(limit), order) else: self.uri = '/api/v1/hardware?order={0}'.format(order) if offset is not None: @@ -138,80 +155,84 @@ def getAssetsByCategory(self, server, token, categoryID, limit=None, order='asc' def getAssetsByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None): """Get list of assets - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API - manufacturerID {string} -- Manufacturer ID to be limited to - offset {string} -- Starting offset to get the data - + manufacturerID {string} -- Manufacturer ID to be limited to + offset {string} -- Starting offset to get the data + Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) order {string} -- Display order of data (asc / desc default:{asc}) - + Returns: [string] -- List of assets from the server, in JSON formatted """ if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order) + self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( + str(limit), order) else: self.uri = '/api/v1/hardware?order={0}'.format(order) if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + '&manufacturer_id={0}'.format(manufacturerID) + self.uri = self.uri + '&offset={0}'.format(str(offset)) + self.server = server + self.uri + \ + '&manufacturer_id={0}'.format(manufacturerID) headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content def getAssetsByCompany(self, server, token, companyID, limit=None, order='asc', offset=None): """Get list of assets - + Arguments: server {string} -- Server URI - token {string} -- Token value to be used for accessing the API + token {string} -- Token value to be used for accessing the API companyID {string} -- CompanyID to be limited to offset {string} -- Starting offset to get the data - + Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) order {string} -- Display order of data (asc / desc default:{asc}) - + Returns: [string] -- List of assets from the server, in JSON formatted """ if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order) + self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( + str(limit), order) else: self.uri = '/api/v1/hardware?order={0}'.format(order) if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) + self.uri = self.uri + '&offset={0}'.format(str(offset)) self.server = server + self.uri + '&company_id={0}'.format(companyID) headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) - return results.content + return results.content def getAssetsByLocation(self, server, token, locationID, limit=None, order='asc', offset=None): """Get list of assets - + Arguments: server {string} -- Server URI - token {string} -- Token value to be used for accessing the API + token {string} -- Token value to be used for accessing the API locationID {string} -- Location ID to be limited to offset {string} -- Starting offset to get the data - + Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) order {string} -- Display order of data (asc / desc default:{asc}) - + Returns: [string] -- List of assets from the server, in JSON formatted """ if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order) + self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( + str(limit), order) else: self.uri = '/api/v1/hardware?order={0}'.format(order) if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) + self.uri = self.uri + '&offset={0}'.format(str(offset)) self.server = server + self.uri + '&location_id={0}'.format(locationID) headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) @@ -219,66 +240,69 @@ def getAssetsByLocation(self, server, token, locationID, limit=None, order='asc' def getAssetsByStatus(self, server, token, status, limit=None, order='asc', offset=None): """Get list of assets - + Arguments: server {string} -- Server URI - token {string} -- Token value to be used for accessing the API + token {string} -- Token value to be used for accessing the API status {string} -- Status types (RTD, Deployed, Undeployable, Deleted, Archived, Requestable) offset {string} -- Starting offset to get the data - + Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) order {string} -- Display order of data (asc / desc default:{asc}) - + Returns: [string] -- List of assets from the server, in JSON formatted """ if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order) + self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( + str(limit), order) else: self.uri = '/api/v1/hardware?order={0}'.format(order) if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) + self.uri = self.uri + '&offset={0}'.format(str(offset)) self.server = server + self.uri + '&status={0}'.format(status) headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) - return results.content + return results.content def getAssetsByStatusLabel(self, server, token, statusLabelID, limit=None, order='asc', offset=None): """Get list of assets - + Arguments: server {string} -- Server URI - token {string} -- Token value to be used for accessing the API + token {string} -- Token value to be used for accessing the API statusLabelID {string} -- Status label ID offset {string} -- Starting offset to get the data - + Keyword Arguments: limit {string} -- Limit the number of data returned by the server (default: {50}) order {string} -- Display order of data (asc / desc default:{asc}) - + Returns: [string] -- List of assets from the server, in JSON formatted """ if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order) + self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( + str(limit), order) else: self.uri = '/api/v1/hardware' + '?order=' + order if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + '&status_id={0}'.format(statusLabelID) + self.uri = self.uri + '&offset={0}'.format(str(offset)) + self.server = server + self.uri + \ + '&status_id={0}'.format(statusLabelID) headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content def getDetailsByID(self, server, token, AssetID): """Get asset details by ID - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API - AssetID {string} -- Asset ID - + AssetID {string} -- Asset ID + Returns: [string] -- Asset details from the server, in JSON formatted """ @@ -290,12 +314,12 @@ def getDetailsByID(self, server, token, AssetID): def getDetailsByTag(self, server, token, AssetTag): """Get asset details by ID - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API - AssetTAG {string} -- Asset TAG - + AssetTAG {string} -- Asset TAG + Returns: [string] -- Asset details from the server, in JSON formatted """ @@ -305,15 +329,14 @@ def getDetailsByTag(self, server, token, AssetTag): results = requests.get(self.server, headers=headers) return results.content - def getDetailsBySerial(self, server, token, AssetSerial): """Get asset details by Serial Number - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API - AssetSerial {string} -- Asset Serial Number - + AssetSerial {string} -- Asset Serial Number + Returns: [string] -- List of assets from the server, in JSON formatted """ @@ -325,144 +348,151 @@ def getDetailsBySerial(self, server, token, AssetSerial): def create(self, server, token, payload): """Create new asset data - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API payload {string} -- Asset data - + Returns: [string] -- Server response in JSON formatted """ self.uri = '/api/v1/hardware' self.server = server + self.uri - headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)} + headers = {'Content-Type': 'application/json', + 'Authorization': 'Bearer {0}'.format(token)} results = requests.post(self.server, headers=headers, data=payload) - return json.dumps(results.json(),indent=4, separators=(',', ':')) + return json.dumps(results.json(), indent=4, separators=(',', ':')) def getID(self, server, token, asset_name): """search asset ID by its name - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API asset_name {string} -- Asset name - + Returns: [string] -- Server response in JSON formatted - """ + """ self.uri = '/api/v1/hardware?search={0}'.format(asset_name) self.server = server + self.uri - headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)} + headers = {'Content-Type': 'application/json', + 'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) - jsonData = json.loads((results.content).decode('utf-8').replace("'",'"')) - #print(jsonData) + jsonData = json.loads( + (results.content).decode('utf-8').replace("'", '"')) + # print(jsonData) if len(jsonData['rows']) < 2 and jsonData['rows'][0]['id'] is not None: AssetID = jsonData['rows'][0]['id'] return AssetID - + def delete(self, server, token, DeviceID): """Delete asset data - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API DeviceID {string} -- Asset ID to be deleted - + Returns: [string] -- Server response in JSON formatted - """ + """ self.uri = '/api/v1/hardware/{0}'.format(DeviceID) - self.server = server + self.uri - headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)} + self.server = server + self.uri + headers = {'Content-Type': 'application/json', + 'Authorization': 'Bearer {0}'.format(token)} results = requests.delete(self.server, headers=headers) jsonData = json.loads(results.content) return jsonData['status'] def updateDevice(self, server, token, DeviceID, payload): """Update asset data - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API DeviceID {string} -- Asset ID payload {string} -- Asset data - + Returns: [string] -- Server response in JSON formatted """ self.uri = '/api/v1/hardware/{0}'.format(DeviceID) self.server = server + self.uri - headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)} + headers = {'Content-Type': 'application/json', + 'Authorization': 'Bearer {0}'.format(token)} results = requests.patch(self.server, headers=headers, data=payload) jsonData = json.loads(results.content) return jsonData['status'] def checkInAsset(self, server, token, assetID, note=None, locationID=None): """Check in an asset - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API assetID {string} -- ID of the asset - + Keyword Arguments: note {string} -- Note of the checkin (default: {None}) locationID {string} -- Location id where the asset checked in (default: {None}) """ self.uri = ('/api/v1/hardware/{0}/checkin'.format(assetID)) - payload = {'note':note, 'location_id':locationID} + payload = {'note': note, 'location_id': locationID} self.server = server + self.uri - headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)} + headers = {'Content-Type': 'application/json', + 'Authorization': 'Bearer {0}'.format(token)} results = requests.post(self.server, headers=headers, data=payload) - return json.dumps(results.json(),indent=4, separators=(',', ':')) + return json.dumps(results.json(), indent=4, separators=(',', ':')) - def checkOutAsset(self, server, token, assetID, note=None, locationID=None): """Check out an asset - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API assetID {string} -- ID of the asset - + Keyword Arguments: note {string} -- Note of the checkin (default: {None}) locationID {string} -- Location id where the asset checked out (default: {None}) """ self.uri = ('/api/v1/hardware/{0}/checkout'.format(assetID)) - payload = {'note':note, 'location_id':locationID} + payload = {'note': note, 'location_id': locationID} self.server = server + self.uri - headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)} + headers = {'Content-Type': 'application/json', + 'Authorization': 'Bearer {0}'.format(token)} results = requests.post(self.server, headers=headers, data=payload) - return json.dumps(results.json(),indent=4, separators=(',', ':')) + return json.dumps(results.json(), indent=4, separators=(',', ':')) def auditAsset(self, server, token, assetTag=None, locationID=None): """Audit an asset - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API - + Keyword Arguments: assetTag {string} -- asset tag to be audited (default: {None}) locationID {[type]} -- location ID to be audited (default: {None}) """ self.uri = '/api/v1/hardware/audit' - payload = {'asset_tag':assetTag, 'location_id':locationID} + payload = {'asset_tag': assetTag, 'location_id': locationID} self.server = server + self.uri - headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)} + headers = {'Content-Type': 'application/json', + 'Authorization': 'Bearer {0}'.format(token)} results = requests.post(self.server, headers=headers, data=payload) - return json.dumps(results.json(),indent=4, separators=(',', ':')) + return json.dumps(results.json(), indent=4, separators=(',', ':')) def getAuditDue(self, server, token): """Gets list of audit dues - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API """ - self.uri = '/api/v1/hardware/audit/due' + self.uri = '/api/v1/hardware/audit/due' self.server = server + self.uri headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) @@ -470,12 +500,12 @@ def getAuditDue(self, server, token): def getAuditOverdue(self, server, token): """Gets list of audit overdues - + Arguments: server {string} -- Server URI token {string} -- Token value to be used for accessing the API """ - self.uri = '/api/v1/hardware/audit/overdue' + self.uri = '/api/v1/hardware/audit/overdue' self.server = server + self.uri headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) From a26587ba19bccda4dd0ded822d45be8d7eae6555 Mon Sep 17 00:00:00 2001 From: Su Gi Date: Wed, 3 Jan 2024 18:56:21 -0800 Subject: [PATCH 02/10] Remove redundant code --- snipeit/Assets.py | 190 ++++++++-------------------------------------- 1 file changed, 31 insertions(+), 159 deletions(-) diff --git a/snipeit/Assets.py b/snipeit/Assets.py index 0a9d28f..ba61fa7 100644 --- a/snipeit/Assets.py +++ b/snipeit/Assets.py @@ -80,8 +80,8 @@ def createBaseRequest(self, server, base_uri, token, limit=None, offset=None): return results.content def get(self, server, token, limit=None, order='asc', offset=None): - base_uri = '/api/v1/hardware?order={0}'.format(order) - return self.createBaseRequest(self, server, base_uri, token, limit, offset) + uri = '/api/v1/hardware?order={0}'.format(order) + return self.createBaseRequest(server, uri, token, limit, offset) def search(self, server, token, limit=None, order='asc', keyword=None, offset=None): """Get list of assets based on search keyword @@ -93,207 +93,79 @@ def search(self, server, token, limit=None, order='asc', keyword=None, offset=No keyword = '' uri = '/api/v1/hardware?order={0}'.format(order) - uri = uri + '&search=' + keyword + uri = uri + '&search=' + str(keyword) - return self.createBaseRequest(self, server, uri, token, limit, offset) + return self.createBaseRequest(server, uri, token, limit, offset) def getAssetsByModel(self, server, token, modelID, limit=None, order='asc', offset=None): - """Get list of assets + """Get list of assets with the given model ID Arguments: - server {string} -- Server URI - token {string} -- Token value to be used for accessing the API modelID {string} -- Model ID to be limited to - offset {string} -- Starting offset to get the data - - Keyword Arguments: - limit {string} -- Limit the number of data returned by the server (default: {50}) - order {string} -- Display order of data (asc / desc default:{asc}) - - Returns: - [string] -- List of assets from the server, in JSON formatted """ - if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( - str(limit), order) - else: - self.uri = '/api/v1/hardware?order={0}'.format(order) - if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri - headers = {'Authorization': 'Bearer {0}'.format(token)} - results = requests.get(self.server, headers=headers) - return results.content + uri = '/api/v1/hardware?order={0}'.format(order) + uri = uri + '&model_id=' + str(modelID) + return self.createBaseRequest(server, uri, token, limit, offset) def getAssetsByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None): - """Get list of assets + """Get list of assets in given category Arguments: - server {string} -- Server URI - token {string} -- Token value to be used for accessing the API categoryID {string} -- Category ID to be limited to - offset {string} -- Starting offset to get the data - - Keyword Arguments: - limit {string} -- Limit the number of data returned by the server (default: {50}) - order {string} -- Display order of data (asc / desc default:{asc}) - - Returns: - [string] -- List of assets from the server, in JSON formatted """ - if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( - str(limit), order) - else: - self.uri = '/api/v1/hardware?order={0}'.format(order) - if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + '&category_id=' + str(categoryID) - headers = {'Authorization': 'Bearer {0}'.format(token)} - results = requests.get(self.server, headers=headers) - return results.content + uri = '/api/v1/hardware?order={0}'.format(order) + uri = uri + '&category_id=' + str(categoryID) + return self.createBaseRequest(server, uri, token, limit, offset) def getAssetsByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None): - """Get list of assets + """Get list of assets from the given manufacturer Arguments: - server {string} -- Server URI - token {string} -- Token value to be used for accessing the API manufacturerID {string} -- Manufacturer ID to be limited to - offset {string} -- Starting offset to get the data - - Keyword Arguments: - limit {string} -- Limit the number of data returned by the server (default: {50}) - order {string} -- Display order of data (asc / desc default:{asc}) - - Returns: - [string] -- List of assets from the server, in JSON formatted """ - if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( - str(limit), order) - else: - self.uri = '/api/v1/hardware?order={0}'.format(order) - if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + \ - '&manufacturer_id={0}'.format(manufacturerID) - headers = {'Authorization': 'Bearer {0}'.format(token)} - results = requests.get(self.server, headers=headers) - return results.content + uri = '/api/v1/hardware?order={0}'.format(order) + uri = uri + '&manufacturer_id={0}'.format(manufacturerID) + return self.createBaseRequest(server, uri, token, limit, offset) def getAssetsByCompany(self, server, token, companyID, limit=None, order='asc', offset=None): - """Get list of assets + """Get list of assets from the given company Arguments: - server {string} -- Server URI - token {string} -- Token value to be used for accessing the API companyID {string} -- CompanyID to be limited to - offset {string} -- Starting offset to get the data - - Keyword Arguments: - limit {string} -- Limit the number of data returned by the server (default: {50}) - order {string} -- Display order of data (asc / desc default:{asc}) - - Returns: - [string] -- List of assets from the server, in JSON formatted """ - if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( - str(limit), order) - else: - self.uri = '/api/v1/hardware?order={0}'.format(order) - if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + '&company_id={0}'.format(companyID) - headers = {'Authorization': 'Bearer {0}'.format(token)} - results = requests.get(self.server, headers=headers) - return results.content + uri = '/api/v1/hardware?order={0}'.format(order) + uri = uri + '&company_id={0}'.format(companyID) + return self.createBaseRequest(server, uri, token, limit, offset) def getAssetsByLocation(self, server, token, locationID, limit=None, order='asc', offset=None): - """Get list of assets + """Get list of assets from the given location Arguments: - server {string} -- Server URI - token {string} -- Token value to be used for accessing the API locationID {string} -- Location ID to be limited to - offset {string} -- Starting offset to get the data - - Keyword Arguments: - limit {string} -- Limit the number of data returned by the server (default: {50}) - order {string} -- Display order of data (asc / desc default:{asc}) - - Returns: - [string] -- List of assets from the server, in JSON formatted """ - if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( - str(limit), order) - else: - self.uri = '/api/v1/hardware?order={0}'.format(order) - if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + '&location_id={0}'.format(locationID) - headers = {'Authorization': 'Bearer {0}'.format(token)} - results = requests.get(self.server, headers=headers) - return results.content + uri = '/api/v1/hardware?order={0}'.format(order) + uri = uri + '&location_id={0}'.format(locationID) + return self.createBaseRequest(server, uri, token, limit, offset) def getAssetsByStatus(self, server, token, status, limit=None, order='asc', offset=None): - """Get list of assets + """Get list of assets with the given status Arguments: - server {string} -- Server URI - token {string} -- Token value to be used for accessing the API status {string} -- Status types (RTD, Deployed, Undeployable, Deleted, Archived, Requestable) - offset {string} -- Starting offset to get the data - - Keyword Arguments: - limit {string} -- Limit the number of data returned by the server (default: {50}) - order {string} -- Display order of data (asc / desc default:{asc}) - - Returns: - [string] -- List of assets from the server, in JSON formatted """ - if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( - str(limit), order) - else: - self.uri = '/api/v1/hardware?order={0}'.format(order) - if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + '&status={0}'.format(status) - headers = {'Authorization': 'Bearer {0}'.format(token)} - results = requests.get(self.server, headers=headers) - return results.content + uri = '/api/v1/hardware?order={0}'.format(order) + uri = uri + '&status={0}'.format(status) + return self.createBaseRequest(server, uri, token, limit, offset) def getAssetsByStatusLabel(self, server, token, statusLabelID, limit=None, order='asc', offset=None): """Get list of assets Arguments: - server {string} -- Server URI - token {string} -- Token value to be used for accessing the API statusLabelID {string} -- Status label ID - offset {string} -- Starting offset to get the data - - Keyword Arguments: - limit {string} -- Limit the number of data returned by the server (default: {50}) - order {string} -- Display order of data (asc / desc default:{asc}) - - Returns: - [string] -- List of assets from the server, in JSON formatted """ - if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( - str(limit), order) - else: - self.uri = '/api/v1/hardware' + '?order=' + order - if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + \ - '&status_id={0}'.format(statusLabelID) - headers = {'Authorization': 'Bearer {0}'.format(token)} - results = requests.get(self.server, headers=headers) - return results.content + uri = '/api/v1/hardware?order={0}'.format(order) + uri = uri + '&status_id={0}'.format(statusLabelID) + return self.createBaseRequest(server, uri, token, limit, offset) def getDetailsByID(self, server, token, AssetID): """Get asset details by ID From 850dcd493775c7632fb410631b3ef959b7019e82 Mon Sep 17 00:00:00 2001 From: Su Gi Date: Wed, 3 Jan 2024 18:59:43 -0800 Subject: [PATCH 03/10] Removed old get function --- snipeit/Assets.py | 48 ++++++++++------------------------------------- 1 file changed, 10 insertions(+), 38 deletions(-) diff --git a/snipeit/Assets.py b/snipeit/Assets.py index ba61fa7..80a74ff 100644 --- a/snipeit/Assets.py +++ b/snipeit/Assets.py @@ -26,35 +26,7 @@ class Assets(object): def __init__(self): pass - def get(self, server, token, limit=None, order='asc', offset=None): - """Get list of assets - - Arguments: - server {string} -- Server URI - token {string} -- Token value to be used for accessing the API - offset {string} -- Starting offset to get the data - - Keyword Arguments: - limit {string} -- Limit the number of data returned by the server (default: {50}) - order {string} -- Display order of data (asc / desc default:{asc}) - - Returns: - [string] -- List of assets from the server, in JSON formatted - """ - if limit is not None: - self.uri = '/api/v1/hardware?limit={0}&order={1}'.format( - str(limit), order) - else: - self.uri = '/api/v1/hardware?order={0}'.format(order) - if offset is not None: - self.uri = self.uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri - headers = {'Authorization': 'Bearer {0}'.format(token)} - results = requests.get(self.server, headers=headers) - return results.content - # return json.dumps(results.json(),indent=4, separators=(',', ':')) - - def createBaseRequest(self, server, base_uri, token, limit=None, offset=None): + def createBaseGetRequest(self, server, base_uri, token, limit=None, offset=None): """Get list of assets Arguments: @@ -81,7 +53,7 @@ def createBaseRequest(self, server, base_uri, token, limit=None, offset=None): def get(self, server, token, limit=None, order='asc', offset=None): uri = '/api/v1/hardware?order={0}'.format(order) - return self.createBaseRequest(server, uri, token, limit, offset) + return self.createBaseGetRequest(server, uri, token, limit, offset) def search(self, server, token, limit=None, order='asc', keyword=None, offset=None): """Get list of assets based on search keyword @@ -95,7 +67,7 @@ def search(self, server, token, limit=None, order='asc', keyword=None, offset=No uri = '/api/v1/hardware?order={0}'.format(order) uri = uri + '&search=' + str(keyword) - return self.createBaseRequest(server, uri, token, limit, offset) + return self.createBaseGetRequest(server, uri, token, limit, offset) def getAssetsByModel(self, server, token, modelID, limit=None, order='asc', offset=None): """Get list of assets with the given model ID @@ -105,7 +77,7 @@ def getAssetsByModel(self, server, token, modelID, limit=None, order='asc', offs """ uri = '/api/v1/hardware?order={0}'.format(order) uri = uri + '&model_id=' + str(modelID) - return self.createBaseRequest(server, uri, token, limit, offset) + return self.createBaseGetRequest(server, uri, token, limit, offset) def getAssetsByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None): """Get list of assets in given category @@ -115,7 +87,7 @@ def getAssetsByCategory(self, server, token, categoryID, limit=None, order='asc' """ uri = '/api/v1/hardware?order={0}'.format(order) uri = uri + '&category_id=' + str(categoryID) - return self.createBaseRequest(server, uri, token, limit, offset) + return self.createBaseGetRequest(server, uri, token, limit, offset) def getAssetsByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None): """Get list of assets from the given manufacturer @@ -125,7 +97,7 @@ def getAssetsByManufacturer(self, server, token, manufacturerID, limit=None, ord """ uri = '/api/v1/hardware?order={0}'.format(order) uri = uri + '&manufacturer_id={0}'.format(manufacturerID) - return self.createBaseRequest(server, uri, token, limit, offset) + return self.createBaseGetRequest(server, uri, token, limit, offset) def getAssetsByCompany(self, server, token, companyID, limit=None, order='asc', offset=None): """Get list of assets from the given company @@ -135,7 +107,7 @@ def getAssetsByCompany(self, server, token, companyID, limit=None, order='asc', """ uri = '/api/v1/hardware?order={0}'.format(order) uri = uri + '&company_id={0}'.format(companyID) - return self.createBaseRequest(server, uri, token, limit, offset) + return self.createBaseGetRequest(server, uri, token, limit, offset) def getAssetsByLocation(self, server, token, locationID, limit=None, order='asc', offset=None): """Get list of assets from the given location @@ -145,7 +117,7 @@ def getAssetsByLocation(self, server, token, locationID, limit=None, order='asc' """ uri = '/api/v1/hardware?order={0}'.format(order) uri = uri + '&location_id={0}'.format(locationID) - return self.createBaseRequest(server, uri, token, limit, offset) + return self.createBaseGetRequest(server, uri, token, limit, offset) def getAssetsByStatus(self, server, token, status, limit=None, order='asc', offset=None): """Get list of assets with the given status @@ -155,7 +127,7 @@ def getAssetsByStatus(self, server, token, status, limit=None, order='asc', offs """ uri = '/api/v1/hardware?order={0}'.format(order) uri = uri + '&status={0}'.format(status) - return self.createBaseRequest(server, uri, token, limit, offset) + return self.createBaseGetRequest(server, uri, token, limit, offset) def getAssetsByStatusLabel(self, server, token, statusLabelID, limit=None, order='asc', offset=None): """Get list of assets @@ -165,7 +137,7 @@ def getAssetsByStatusLabel(self, server, token, statusLabelID, limit=None, order """ uri = '/api/v1/hardware?order={0}'.format(order) uri = uri + '&status_id={0}'.format(statusLabelID) - return self.createBaseRequest(server, uri, token, limit, offset) + return self.createBaseGetRequest(server, uri, token, limit, offset) def getDetailsByID(self, server, token, AssetID): """Get asset details by ID From f1938e1e7f51728335ecb0eed631ec1a10517ced Mon Sep 17 00:00:00 2001 From: Su Gi Date: Thu, 4 Jan 2024 19:40:34 -0800 Subject: [PATCH 04/10] Use pyproject.toml --- README.rst => README.md | 0 pyproject.toml | 3 +++ setup.cfg | 17 +++++++++++++++++ setup.py | 17 ----------------- {snipeit => snipeitpyapi}/Accessories.py | 0 {snipeit => snipeitpyapi}/Assets.py | 7 ++++--- {snipeit => snipeitpyapi}/AssetsMaintenances.py | 0 {snipeit => snipeitpyapi}/Categories.py | 0 {snipeit => snipeitpyapi}/Company.py | 0 {snipeit => snipeitpyapi}/Components.py | 0 {snipeit => snipeitpyapi}/Consumables.py | 0 {snipeit => snipeitpyapi}/DataUtil.py | 0 {snipeit => snipeitpyapi}/Fieldsets.py | 0 {snipeit => snipeitpyapi}/Licenses.py | 0 {snipeit => snipeitpyapi}/Locations.py | 0 {snipeit => snipeitpyapi}/Maintenances.py | 0 {snipeit => snipeitpyapi}/Manufacturers.py | 0 {snipeit => snipeitpyapi}/Models.py | 0 {snipeit => snipeitpyapi}/StatusLabels.py | 0 {snipeit => snipeitpyapi}/Users.py | 0 {snipeit => snipeitpyapi}/__init__.py | 0 21 files changed, 24 insertions(+), 20 deletions(-) rename README.rst => README.md (100%) create mode 100644 pyproject.toml create mode 100644 setup.cfg delete mode 100644 setup.py rename {snipeit => snipeitpyapi}/Accessories.py (100%) rename {snipeit => snipeitpyapi}/Assets.py (98%) rename {snipeit => snipeitpyapi}/AssetsMaintenances.py (100%) rename {snipeit => snipeitpyapi}/Categories.py (100%) rename {snipeit => snipeitpyapi}/Company.py (100%) rename {snipeit => snipeitpyapi}/Components.py (100%) rename {snipeit => snipeitpyapi}/Consumables.py (100%) rename {snipeit => snipeitpyapi}/DataUtil.py (100%) rename {snipeit => snipeitpyapi}/Fieldsets.py (100%) rename {snipeit => snipeitpyapi}/Licenses.py (100%) rename {snipeit => snipeitpyapi}/Locations.py (100%) rename {snipeit => snipeitpyapi}/Maintenances.py (100%) rename {snipeit => snipeitpyapi}/Manufacturers.py (100%) rename {snipeit => snipeitpyapi}/Models.py (100%) rename {snipeit => snipeitpyapi}/StatusLabels.py (100%) rename {snipeit => snipeitpyapi}/Users.py (100%) rename {snipeit => snipeitpyapi}/__init__.py (100%) diff --git a/README.rst b/README.md similarity index 100% rename from README.rst rename to README.md diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..7fd26b9 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" \ No newline at end of file diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..275eefa --- /dev/null +++ b/setup.cfg @@ -0,0 +1,17 @@ +[metadata] +name = snipeitpyapi +version = 1.0.0 +author = Su Gi Chandran +url = https://github.com/Honoo/SnipeIT-PythonAPI +description = Python library to access the Snipe-IT API +long_description = file: README.md +long_description_content_type = text/markdown +license = MIT + +[options] +zip_safe = True +packages = find: +python_requires = >=3.6 +install_requires= + requests + simplejson \ No newline at end of file diff --git a/setup.py b/setup.py deleted file mode 100644 index dad1a40..0000000 --- a/setup.py +++ /dev/null @@ -1,17 +0,0 @@ -from setuptools import setup - -with open("README.rst","r") as fh: - long_description = fh.read() - -setup(name='snipeit', - version='1.2', - long_description=long_description, - long_description_content_type="text/markdown", - description=("Python library to access the SnipeIT API"), - url='https://github.com/jbloomer/SnipeIT-PythonAPI', - author='Jared Bloomer (Cox Automotive Inc.)', - author_email='jared.bloomer@coxautoinc.com', - license='MIT', - packages=['snipeit'], - install_requires=['requests','simplejson'], - zip_safe=False) diff --git a/snipeit/Accessories.py b/snipeitpyapi/Accessories.py similarity index 100% rename from snipeit/Accessories.py rename to snipeitpyapi/Accessories.py diff --git a/snipeit/Assets.py b/snipeitpyapi/Assets.py similarity index 98% rename from snipeit/Assets.py rename to snipeitpyapi/Assets.py index 80a74ff..305fed1 100644 --- a/snipeit/Assets.py +++ b/snipeitpyapi/Assets.py @@ -41,12 +41,13 @@ def createBaseGetRequest(self, server, base_uri, token, limit=None, offset=None) Returns: [string] -- List of assets from the server, in JSON format """ + uri = base_uri if limit is not None: - self.uri = base_uri + '&limit={0}'.format(str(limit)) + uri = base_uri + '&limit={0}'.format(str(limit)) if offset is not None: - self.uri = base_uri + '&offset={0}'.format(str(offset)) + uri = base_uri + '&offset={0}'.format(str(offset)) - self.server = server + self.uri + self.server = server + uri headers = {'Authorization': 'Bearer {0}'.format(token)} results = requests.get(self.server, headers=headers) return results.content diff --git a/snipeit/AssetsMaintenances.py b/snipeitpyapi/AssetsMaintenances.py similarity index 100% rename from snipeit/AssetsMaintenances.py rename to snipeitpyapi/AssetsMaintenances.py diff --git a/snipeit/Categories.py b/snipeitpyapi/Categories.py similarity index 100% rename from snipeit/Categories.py rename to snipeitpyapi/Categories.py diff --git a/snipeit/Company.py b/snipeitpyapi/Company.py similarity index 100% rename from snipeit/Company.py rename to snipeitpyapi/Company.py diff --git a/snipeit/Components.py b/snipeitpyapi/Components.py similarity index 100% rename from snipeit/Components.py rename to snipeitpyapi/Components.py diff --git a/snipeit/Consumables.py b/snipeitpyapi/Consumables.py similarity index 100% rename from snipeit/Consumables.py rename to snipeitpyapi/Consumables.py diff --git a/snipeit/DataUtil.py b/snipeitpyapi/DataUtil.py similarity index 100% rename from snipeit/DataUtil.py rename to snipeitpyapi/DataUtil.py diff --git a/snipeit/Fieldsets.py b/snipeitpyapi/Fieldsets.py similarity index 100% rename from snipeit/Fieldsets.py rename to snipeitpyapi/Fieldsets.py diff --git a/snipeit/Licenses.py b/snipeitpyapi/Licenses.py similarity index 100% rename from snipeit/Licenses.py rename to snipeitpyapi/Licenses.py diff --git a/snipeit/Locations.py b/snipeitpyapi/Locations.py similarity index 100% rename from snipeit/Locations.py rename to snipeitpyapi/Locations.py diff --git a/snipeit/Maintenances.py b/snipeitpyapi/Maintenances.py similarity index 100% rename from snipeit/Maintenances.py rename to snipeitpyapi/Maintenances.py diff --git a/snipeit/Manufacturers.py b/snipeitpyapi/Manufacturers.py similarity index 100% rename from snipeit/Manufacturers.py rename to snipeitpyapi/Manufacturers.py diff --git a/snipeit/Models.py b/snipeitpyapi/Models.py similarity index 100% rename from snipeit/Models.py rename to snipeitpyapi/Models.py diff --git a/snipeit/StatusLabels.py b/snipeitpyapi/StatusLabels.py similarity index 100% rename from snipeit/StatusLabels.py rename to snipeitpyapi/StatusLabels.py diff --git a/snipeit/Users.py b/snipeitpyapi/Users.py similarity index 100% rename from snipeit/Users.py rename to snipeitpyapi/Users.py diff --git a/snipeit/__init__.py b/snipeitpyapi/__init__.py similarity index 100% rename from snipeit/__init__.py rename to snipeitpyapi/__init__.py From 8ab712efa6c2d572f1c793788cb8ea88438b708f Mon Sep 17 00:00:00 2001 From: Su Gi Date: Mon, 8 Jan 2024 16:36:58 -0800 Subject: [PATCH 05/10] Update README.md --- README.md | 152 +++--------------------------------------------------- 1 file changed, 8 insertions(+), 144 deletions(-) diff --git a/README.md b/README.md index 213cea8..8211f02 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ SnipeIT Python API ================== -Use this package to interface with the SnipeIT (https://snipeitapp.com/) -API directly from Python. +This repository is a fork of the archived [SnipeIT-PythonAPI](https://github.com/jbloomer/SnipeIT-PythonAPI) repository. It contains additional bug fixes. + +Use this package to interface with the SnipeIT (https://snipeitapp.com/) API directly from Python. Installation ------------ -Run the command ``pip install snipeit`` +Run the command ``pip install snipeitpyapi`` Usage ----- - -- See Example Scripts included in package for specific calls +See Example Scripts included in package for specific calls API Features ------------ @@ -32,154 +32,18 @@ API Features - ☒ Custom Fieldsets - ☒ Maintenances -|Completed| - -Release History ---------------- - -- 0.12 - - - Synchronizing API features based on Snipe-IT version 4.7.5 - - Added audit command under Assets class - - Added audit due & overdue under Assets class - - Added asset checkin & checkout under Assets class - - Fix various typos on input parameters in some classes - - Add DataUtil module for some small response data management functions - - Add SimpleAssetBrowser script as an example of asset browsing by utilizing pySimpleGUI & pandas - - Add DataUtilUsageExample - - Updating Doc folder - -- 0.11 - - - Completing API features based on Snipe-IT version 4.6.14 - - - Added Categories class - - Added Fieldsets class - - Added Missing Licenses class - - Added Manufacturers class - - Added Maintenances class - - Added docstrings for each methods - - Removed unrelated methods in some classes - - Added search() method for all supported APIs - - Update get() methods to incorporate ordering - - Added many new methods in each class (see documentation files) - - Added documentation files - -- 0.10 - - - Update import issue in python3 - - - Updated **init**.py to python 3 import style - -- 0.9 - - - Created Support for Models - - - Added get() method to get JSON dump of Models - - Added create() method to add new items to Models - - Added getID() method to get the ID of a specified Models - - Added delete() method to remove items from Models - - Added updateModel() method (Uses PATCH call) to update details - on a existing Model - -- 0.8 - - - Created Support for StatusLabels - - - Added get() method to get JSON dump of Status Labels - - Added create() method to add new items to Status Labels - - Added getID() method to get the ID of a specified Status Labels - - Added delete() method to remove items from Status Labels - - Added updateStatusLabels() method (Uses PATCH call) to update - details on a existing Status Label - -- 0.7 - - - Created Support for Users - - - Added get() method to get JSON dump of Users - - Added create() method to add new items to Users - - Added getID() method to get the ID of a specified Users - - Added delete() method to remove items from Users - - Added updateUser() method (Uses PATCH call) to update details - on a existing Users - - Added getCheckedOutAssets() method to get a list of Assets - assigned to that User - -- 0.6 - - - Created Support for Components - - - Added get() method to get JSON dump of Components - - Added create() method to add new items to Components - - Added getID() method to get the ID of a specified Components - - Added viewID() method to see details of Components - -- 0.5 - - - Creating Support for Consumable API Calls - - - Added get() method to get JSON dump of Consumables - - Added create() method to add new items to Consumables - - Added getID() method to get the ID of a specified consumable - - Added viewID() method to get details of a specific consumable - -- 0.4 - - - Creating Support for Accessory API Calls - - - Added get() method to get JSON dump of AccessoriesID - - Added create() method to add new items to Accessories - - Added getID() method to get the ID of a specified accessories - - Added viewID() method to get details of a specific accessory - -- 0.3 - - - Creating Support for Locations API Calls - - - Added get() method to get JSON dump of locations - - Added create() method to add new items to locations - - Added getID() method to get the ID of a specified locations - - Added updateCompany() method (Uses PATCH call) to update the - name of an existing location. - - Added delete() method to remove items from locations - -- 0.2 - - - Creating Support for Company API Calls - - - Added get() method to get JSON dump of companies - - Added create() method to add new items to companies - - Added getID() method to get the ID of a specified company - - Added delete() method to remove items from companies - - Added updateCompany() method (Uses PATCH call) to update the - name of an existing company. - -- 0.1 - - - Created Support for Assets - - - Added get() method to get JSON dump of inventory - - Added create() method to add new items to inventory - - Added getID() method to get the ID of a specified device in the - inventory - - Added delete() method to remove items from inventory - - Added updateDevice() method (Uses PATCH call) to update details - on a device currently in inventory. - Contributing ------------ -1. Fork it! +1. Fork this repository 2. Create your feature branch: ``git checkout -b my-new-feature`` 3. Commit your changes: ``git commit -am 'Add some feature'`` 4. Push to the branch: ``git push origin my-new-feature`` -5. Submit a pull request :D +5. Submit a pull request to this repository Credits ------- - -Cox Automotive Inc. \* https://www.coxautoinc.com/ \* Author: Jared +Original repository: Cox Automotive Inc. \* https://www.coxautoinc.com/ \* Author: Jared Bloomer License From 87739836c1183b5c2caec1b0661794d0c4c6e12a Mon Sep 17 00:00:00 2001 From: Su Gi Date: Mon, 8 Jan 2024 16:38:26 -0800 Subject: [PATCH 06/10] Update README.md --- README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8211f02..30aa525 100644 --- a/README.md +++ b/README.md @@ -43,15 +43,10 @@ Contributing Credits ------- -Original repository: Cox Automotive Inc. \* https://www.coxautoinc.com/ \* Author: Jared -Bloomer +Original repository: Cox Automotive Inc. \* https://www.coxautoinc.com/ \* Author: Jared Bloomer License ------- -This Project is currently released under the MIT license. For the latest -copy of the MIT license please refer to -https://opensource.org/licenses/MIT - -.. |Completed| image:: http://progressed.io/bar/100?title=completed +This Project is currently released under the MIT license. For the latest copy of the MIT license, please refer to https://opensource.org/licenses/MIT From 8f00391f0030738b58610080a363094b3c0cf4da Mon Sep 17 00:00:00 2001 From: Su Gi Date: Tue, 9 Jan 2024 01:51:17 -0800 Subject: [PATCH 07/10] Add changelog --- CHANGELOG.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..684cc63 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ + +# Change Log +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) +and this project adheres to [Semantic Versioning](http://semver.org/). + +## [1.0.0] - 2023-01-09 + +### Added + +### Changed +- In `Assets.py`, consolidate redundant code in `getAsset...` functions to create a request and call the Snipe-IT server into one function. +- For builds: stop using `setup.py`, which is deprecated, and switch to `pyproject.toml`. + +### Fixed +- In `Assets::getAssetsByModel()`, actually use the model ID parameter when making the request. \ No newline at end of file From 4a80bf6efd2e25a2f8c749d23df30c011a007084 Mon Sep 17 00:00:00 2001 From: Su Gi Date: Tue, 9 Jan 2024 01:59:14 -0800 Subject: [PATCH 08/10] Fix incorrect date in changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 684cc63..ddea24e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). -## [1.0.0] - 2023-01-09 +## [1.0.0] - 2024-01-09 ### Added From e1b1c2978c23428807720ecbe7609fbb64a6e636 Mon Sep 17 00:00:00 2001 From: Su Gi Date: Tue, 9 Jan 2024 02:45:07 -0800 Subject: [PATCH 09/10] Rename package --- README.md | 2 +- setup.cfg | 2 +- {snipeitpyapi => snipeitpythonapi}/Accessories.py | 0 {snipeitpyapi => snipeitpythonapi}/Assets.py | 0 {snipeitpyapi => snipeitpythonapi}/AssetsMaintenances.py | 0 {snipeitpyapi => snipeitpythonapi}/Categories.py | 0 {snipeitpyapi => snipeitpythonapi}/Company.py | 0 {snipeitpyapi => snipeitpythonapi}/Components.py | 0 {snipeitpyapi => snipeitpythonapi}/Consumables.py | 0 {snipeitpyapi => snipeitpythonapi}/DataUtil.py | 0 {snipeitpyapi => snipeitpythonapi}/Fieldsets.py | 0 {snipeitpyapi => snipeitpythonapi}/Licenses.py | 0 {snipeitpyapi => snipeitpythonapi}/Locations.py | 0 {snipeitpyapi => snipeitpythonapi}/Maintenances.py | 0 {snipeitpyapi => snipeitpythonapi}/Manufacturers.py | 0 {snipeitpyapi => snipeitpythonapi}/Models.py | 0 {snipeitpyapi => snipeitpythonapi}/StatusLabels.py | 0 {snipeitpyapi => snipeitpythonapi}/Users.py | 0 {snipeitpyapi => snipeitpythonapi}/__init__.py | 0 19 files changed, 2 insertions(+), 2 deletions(-) rename {snipeitpyapi => snipeitpythonapi}/Accessories.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Assets.py (100%) rename {snipeitpyapi => snipeitpythonapi}/AssetsMaintenances.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Categories.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Company.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Components.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Consumables.py (100%) rename {snipeitpyapi => snipeitpythonapi}/DataUtil.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Fieldsets.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Licenses.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Locations.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Maintenances.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Manufacturers.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Models.py (100%) rename {snipeitpyapi => snipeitpythonapi}/StatusLabels.py (100%) rename {snipeitpyapi => snipeitpythonapi}/Users.py (100%) rename {snipeitpyapi => snipeitpythonapi}/__init__.py (100%) diff --git a/README.md b/README.md index 30aa525..c3cfdf9 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Use this package to interface with the SnipeIT (https://snipeitapp.com/) API dir Installation ------------ -Run the command ``pip install snipeitpyapi`` +Run the command ``pip install snipeitpythonapi`` Usage ----- diff --git a/setup.cfg b/setup.cfg index 275eefa..c3d03a1 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [metadata] -name = snipeitpyapi +name = snipeitpythonapi version = 1.0.0 author = Su Gi Chandran url = https://github.com/Honoo/SnipeIT-PythonAPI diff --git a/snipeitpyapi/Accessories.py b/snipeitpythonapi/Accessories.py similarity index 100% rename from snipeitpyapi/Accessories.py rename to snipeitpythonapi/Accessories.py diff --git a/snipeitpyapi/Assets.py b/snipeitpythonapi/Assets.py similarity index 100% rename from snipeitpyapi/Assets.py rename to snipeitpythonapi/Assets.py diff --git a/snipeitpyapi/AssetsMaintenances.py b/snipeitpythonapi/AssetsMaintenances.py similarity index 100% rename from snipeitpyapi/AssetsMaintenances.py rename to snipeitpythonapi/AssetsMaintenances.py diff --git a/snipeitpyapi/Categories.py b/snipeitpythonapi/Categories.py similarity index 100% rename from snipeitpyapi/Categories.py rename to snipeitpythonapi/Categories.py diff --git a/snipeitpyapi/Company.py b/snipeitpythonapi/Company.py similarity index 100% rename from snipeitpyapi/Company.py rename to snipeitpythonapi/Company.py diff --git a/snipeitpyapi/Components.py b/snipeitpythonapi/Components.py similarity index 100% rename from snipeitpyapi/Components.py rename to snipeitpythonapi/Components.py diff --git a/snipeitpyapi/Consumables.py b/snipeitpythonapi/Consumables.py similarity index 100% rename from snipeitpyapi/Consumables.py rename to snipeitpythonapi/Consumables.py diff --git a/snipeitpyapi/DataUtil.py b/snipeitpythonapi/DataUtil.py similarity index 100% rename from snipeitpyapi/DataUtil.py rename to snipeitpythonapi/DataUtil.py diff --git a/snipeitpyapi/Fieldsets.py b/snipeitpythonapi/Fieldsets.py similarity index 100% rename from snipeitpyapi/Fieldsets.py rename to snipeitpythonapi/Fieldsets.py diff --git a/snipeitpyapi/Licenses.py b/snipeitpythonapi/Licenses.py similarity index 100% rename from snipeitpyapi/Licenses.py rename to snipeitpythonapi/Licenses.py diff --git a/snipeitpyapi/Locations.py b/snipeitpythonapi/Locations.py similarity index 100% rename from snipeitpyapi/Locations.py rename to snipeitpythonapi/Locations.py diff --git a/snipeitpyapi/Maintenances.py b/snipeitpythonapi/Maintenances.py similarity index 100% rename from snipeitpyapi/Maintenances.py rename to snipeitpythonapi/Maintenances.py diff --git a/snipeitpyapi/Manufacturers.py b/snipeitpythonapi/Manufacturers.py similarity index 100% rename from snipeitpyapi/Manufacturers.py rename to snipeitpythonapi/Manufacturers.py diff --git a/snipeitpyapi/Models.py b/snipeitpythonapi/Models.py similarity index 100% rename from snipeitpyapi/Models.py rename to snipeitpythonapi/Models.py diff --git a/snipeitpyapi/StatusLabels.py b/snipeitpythonapi/StatusLabels.py similarity index 100% rename from snipeitpyapi/StatusLabels.py rename to snipeitpythonapi/StatusLabels.py diff --git a/snipeitpyapi/Users.py b/snipeitpythonapi/Users.py similarity index 100% rename from snipeitpyapi/Users.py rename to snipeitpythonapi/Users.py diff --git a/snipeitpyapi/__init__.py b/snipeitpythonapi/__init__.py similarity index 100% rename from snipeitpyapi/__init__.py rename to snipeitpythonapi/__init__.py From 2548a94432185dd8fe7c4007c82ba10401cfc746 Mon Sep 17 00:00:00 2001 From: Su Gi Date: Sun, 24 Mar 2024 00:56:32 -0700 Subject: [PATCH 10/10] Remove extraneous examples --- AccessoriesGetIDRequestExample.py | 11 - AccessoriesGetRequestExample.py | 11 - AccessoriesPostRequestExample.py | 11 - AccessoriesViewIDRequestExample.py | 11 - AssetDeleteRequestExample.py | 11 - AssetGetIDRequestExample.py | 11 - AssetGetRequestExample.py | 12 - AssetPostRequestExample.py | 11 - AssetUpdateDeviceRequestExample.py | 13 - CompanyDeleteRequestExample.py | 11 - CompanyGetIDRequestExample.py | 11 - CompanyGetRequestExample.py | 11 - CompanyPostRequestExample.py | 11 - CompanyUpdateCompanyRequestExample.py | 12 - ComponentsGetIDRequestExample.py | 11 - ComponentsGetRequestExample.py | 11 - ComponentsPostRequestExample.py | 11 - ComponentsViewIDRequestExample.py | 11 - ConsumablesGetIDRequestExample.py | 11 - ConsumablesGetRequestExample.py | 11 - ConsumablesPostRequestExample.py | 11 - ConsumablesViewIDRequestExample.py | 11 - LocationsDeleteRequestExample.py | 11 - LocationsGetIDRequestExample.py | 11 - LocationsGetRequestExample.py | 11 - LocationsPostRequestExample.py | 11 - LocationsUpdateDeviceRequestExample.py | 12 - ModelsDeleteRequestExample.py | 11 - ModelsGetIDRequestExample.py | 11 - ModelsGetRequestExample.py | 12 - ModelsPostRequestExample.py | 11 - ModelsUpdateDeviceRequestExample.py | 12 - StatusLabelsDeleteRequestExample.py | 11 - StatusLabelsGetIDRequestExample.py | 11 - StatusLabelsGetRequestExample.py | 12 - StatusLabelsPostRequestExample.py | 11 - StatusLabelsUpdateDeviceRequestExample.py | 12 - UserDeleteRequestExample.py | 11 - UsersGetAssetsRequestExample.py | 12 - UsersGetIDRequestExample.py | 11 - UsersGetRequestExample.py | 12 - UsersPostRequestExample.py | 12 - UsersUpdateUserRequestExample.py | 12 - doc/snipeit/Accessories.html | 444 ----- doc/snipeit/Assets.html | 1829 --------------------- doc/snipeit/Categories.html | 606 ------- doc/snipeit/Company.html | 464 ------ doc/snipeit/Components.html | 450 ----- doc/snipeit/Consumables.html | 829 ---------- doc/snipeit/Fieldsets.html | 472 ------ doc/snipeit/Licenses.html | 596 ------- doc/snipeit/Locations.html | 591 ------- doc/snipeit/Maintenances.html | 480 ------ doc/snipeit/Manufacturers.html | 476 ------ doc/snipeit/Models.html | 596 ------- doc/snipeit/StatusLabels.html | 662 -------- doc/snipeit/Users.html | 800 --------- doc/snipeit/index.html | 152 -- examples.py | 8 + 59 files changed, 8 insertions(+), 9933 deletions(-) delete mode 100755 AccessoriesGetIDRequestExample.py delete mode 100755 AccessoriesGetRequestExample.py delete mode 100755 AccessoriesPostRequestExample.py delete mode 100755 AccessoriesViewIDRequestExample.py delete mode 100755 AssetDeleteRequestExample.py delete mode 100755 AssetGetIDRequestExample.py delete mode 100755 AssetGetRequestExample.py delete mode 100755 AssetPostRequestExample.py delete mode 100755 AssetUpdateDeviceRequestExample.py delete mode 100755 CompanyDeleteRequestExample.py delete mode 100755 CompanyGetIDRequestExample.py delete mode 100755 CompanyGetRequestExample.py delete mode 100755 CompanyPostRequestExample.py delete mode 100755 CompanyUpdateCompanyRequestExample.py delete mode 100755 ComponentsGetIDRequestExample.py delete mode 100755 ComponentsGetRequestExample.py delete mode 100755 ComponentsPostRequestExample.py delete mode 100755 ComponentsViewIDRequestExample.py delete mode 100755 ConsumablesGetIDRequestExample.py delete mode 100755 ConsumablesGetRequestExample.py delete mode 100755 ConsumablesPostRequestExample.py delete mode 100755 ConsumablesViewIDRequestExample.py delete mode 100755 LocationsDeleteRequestExample.py delete mode 100755 LocationsGetIDRequestExample.py delete mode 100755 LocationsGetRequestExample.py delete mode 100755 LocationsPostRequestExample.py delete mode 100755 LocationsUpdateDeviceRequestExample.py delete mode 100755 ModelsDeleteRequestExample.py delete mode 100755 ModelsGetIDRequestExample.py delete mode 100755 ModelsGetRequestExample.py delete mode 100755 ModelsPostRequestExample.py delete mode 100755 ModelsUpdateDeviceRequestExample.py delete mode 100755 StatusLabelsDeleteRequestExample.py delete mode 100755 StatusLabelsGetIDRequestExample.py delete mode 100755 StatusLabelsGetRequestExample.py delete mode 100755 StatusLabelsPostRequestExample.py delete mode 100755 StatusLabelsUpdateDeviceRequestExample.py delete mode 100755 UserDeleteRequestExample.py delete mode 100755 UsersGetAssetsRequestExample.py delete mode 100755 UsersGetIDRequestExample.py delete mode 100755 UsersGetRequestExample.py delete mode 100755 UsersPostRequestExample.py delete mode 100755 UsersUpdateUserRequestExample.py delete mode 100644 doc/snipeit/Accessories.html delete mode 100644 doc/snipeit/Assets.html delete mode 100644 doc/snipeit/Categories.html delete mode 100644 doc/snipeit/Company.html delete mode 100644 doc/snipeit/Components.html delete mode 100644 doc/snipeit/Consumables.html delete mode 100644 doc/snipeit/Fieldsets.html delete mode 100644 doc/snipeit/Licenses.html delete mode 100644 doc/snipeit/Locations.html delete mode 100644 doc/snipeit/Maintenances.html delete mode 100644 doc/snipeit/Manufacturers.html delete mode 100644 doc/snipeit/Models.html delete mode 100644 doc/snipeit/StatusLabels.html delete mode 100644 doc/snipeit/Users.html delete mode 100644 doc/snipeit/index.html create mode 100644 examples.py diff --git a/AccessoriesGetIDRequestExample.py b/AccessoriesGetIDRequestExample.py deleted file mode 100755 index 4467807..0000000 --- a/AccessoriesGetIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Accessories - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -A = Accessories() -r = A.getID(server, token, "thisisunique17") -print r diff --git a/AccessoriesGetRequestExample.py b/AccessoriesGetRequestExample.py deleted file mode 100755 index 874a783..0000000 --- a/AccessoriesGetRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Accessories - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -A = Accessories() -r = A.get(server, token) -print r diff --git a/AccessoriesPostRequestExample.py b/AccessoriesPostRequestExample.py deleted file mode 100755 index 4a448bb..0000000 --- a/AccessoriesPostRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Accessories - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - -A = Accessories() -payload = '{"name":"thisisunique17","qty":1,"category_id":8}' -r = A.create(server, token, payload) -print r diff --git a/AccessoriesViewIDRequestExample.py b/AccessoriesViewIDRequestExample.py deleted file mode 100755 index 6b85932..0000000 --- a/AccessoriesViewIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Accessories - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -A = Accessories() -r = A.viewID(server, token, "1") -print r diff --git a/AssetDeleteRequestExample.py b/AssetDeleteRequestExample.py deleted file mode 100755 index aa10c4f..0000000 --- a/AssetDeleteRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Assets - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -A = Assets() -r = A.delete(server, token, "2652") -print r diff --git a/AssetGetIDRequestExample.py b/AssetGetIDRequestExample.py deleted file mode 100755 index 6553127..0000000 --- a/AssetGetIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Assets - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -A = Assets() -r = A.getID(server, token, "thisisunique17") -print r diff --git a/AssetGetRequestExample.py b/AssetGetRequestExample.py deleted file mode 100755 index a1f4251..0000000 --- a/AssetGetRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Assets - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -A = Assets() -#r = A.get(server, token, 5) # With a limit of results -r = A.get(server, token) # Using default limit of 50 for results -print r diff --git a/AssetPostRequestExample.py b/AssetPostRequestExample.py deleted file mode 100755 index 4caa77c..0000000 --- a/AssetPostRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Assets - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - -A = Assets() -payload = '{"asset_tag":"thisisunique17","status_id":1,"model_id": 5}' -r = A.create(server, token, payload) -print r diff --git a/AssetUpdateDeviceRequestExample.py b/AssetUpdateDeviceRequestExample.py deleted file mode 100755 index 61a718a..0000000 --- a/AssetUpdateDeviceRequestExample.py +++ /dev/null @@ -1,13 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Assets - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -A = Assets() -#payload = '{"asset_tag":"thisisunique17","model_id": 5,"_snipeit_application_3": "Test Application"}' -payload = '{"asset_tag":"thisisunique17","status_id": 1,"model_id": 5}' -r = A.updateDevice(server, token, "2654", payload) -print r diff --git a/CompanyDeleteRequestExample.py b/CompanyDeleteRequestExample.py deleted file mode 100755 index 66976ac..0000000 --- a/CompanyDeleteRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Company - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Company() -r = C.delete(server, token, "5") -print r diff --git a/CompanyGetIDRequestExample.py b/CompanyGetIDRequestExample.py deleted file mode 100755 index eb0a756..0000000 --- a/CompanyGetIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Company - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Company() -r = C.getID(server, token, "My Test Company") -print r diff --git a/CompanyGetRequestExample.py b/CompanyGetRequestExample.py deleted file mode 100755 index 06e1dbc..0000000 --- a/CompanyGetRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Company - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Company() -r = C.get(server, token) -print r diff --git a/CompanyPostRequestExample.py b/CompanyPostRequestExample.py deleted file mode 100755 index 31c2b2d..0000000 --- a/CompanyPostRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Company - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - -C = Company() -payload = '{"name":"My Test Company"}' -r = C.create(server, token, payload) -print r diff --git a/CompanyUpdateCompanyRequestExample.py b/CompanyUpdateCompanyRequestExample.py deleted file mode 100755 index 717f9ca..0000000 --- a/CompanyUpdateCompanyRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Company - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Company() -payload = '{"name":"Another Company"}' -r = C.updateCompany(server, token, "6", payload) -print r diff --git a/ComponentsGetIDRequestExample.py b/ComponentsGetIDRequestExample.py deleted file mode 100755 index dc923bb..0000000 --- a/ComponentsGetIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Components - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Components() -r = C.getID(server, token, "thisisunique17") -print r diff --git a/ComponentsGetRequestExample.py b/ComponentsGetRequestExample.py deleted file mode 100755 index f9c9d98..0000000 --- a/ComponentsGetRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Components - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Components() -r = C.get(server, token) -print r diff --git a/ComponentsPostRequestExample.py b/ComponentsPostRequestExample.py deleted file mode 100755 index 04a3322..0000000 --- a/ComponentsPostRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Components - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - -C = Components() -payload = '{"name":"thisisunique17","qty":"1","category_id":9}' -r = C.create(server, token, payload) -print r diff --git a/ComponentsViewIDRequestExample.py b/ComponentsViewIDRequestExample.py deleted file mode 100755 index 6296158..0000000 --- a/ComponentsViewIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Components - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Components() -r = C.viewID(server, token, "1") -print r diff --git a/ConsumablesGetIDRequestExample.py b/ConsumablesGetIDRequestExample.py deleted file mode 100755 index f1678f0..0000000 --- a/ConsumablesGetIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Consumables - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Consumables() -r = C.getID(server, token, "thisisunique17") -print r diff --git a/ConsumablesGetRequestExample.py b/ConsumablesGetRequestExample.py deleted file mode 100755 index c951866..0000000 --- a/ConsumablesGetRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Consumables - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Consumables() -r = C.get(server, token) -print r diff --git a/ConsumablesPostRequestExample.py b/ConsumablesPostRequestExample.py deleted file mode 100755 index 82d128d..0000000 --- a/ConsumablesPostRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Consumables - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - -C = Consumables() -payload = '{"name":"thisisunique17","qty":"1","category_id":9}' -r = C.create(server, token, payload) -print r diff --git a/ConsumablesViewIDRequestExample.py b/ConsumablesViewIDRequestExample.py deleted file mode 100755 index f1a1772..0000000 --- a/ConsumablesViewIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Consumables - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -C = Consumables() -r = C.viewID(server, token, "1") -print r diff --git a/LocationsDeleteRequestExample.py b/LocationsDeleteRequestExample.py deleted file mode 100755 index e2f4601..0000000 --- a/LocationsDeleteRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Locations - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -L = Locations() -r = L.delete(server, token, "864") -print r diff --git a/LocationsGetIDRequestExample.py b/LocationsGetIDRequestExample.py deleted file mode 100755 index 4e21719..0000000 --- a/LocationsGetIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Locations - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -L = Locations() -r = L.getID(server, token, "Test Location") -print r diff --git a/LocationsGetRequestExample.py b/LocationsGetRequestExample.py deleted file mode 100755 index 6f9895d..0000000 --- a/LocationsGetRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Locations - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -L = Locations() -r = L.get(server, token) -print r diff --git a/LocationsPostRequestExample.py b/LocationsPostRequestExample.py deleted file mode 100755 index 08e2de4..0000000 --- a/LocationsPostRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Locations - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - -L = Locations() -payload = '{"name":"Test Location","address":"123 Some Street","address2":"Suite 2","state":"GA","country":"US","zip":"30328"}' -r = L.create(server, token, payload) -print r diff --git a/LocationsUpdateDeviceRequestExample.py b/LocationsUpdateDeviceRequestExample.py deleted file mode 100755 index 03f00b0..0000000 --- a/LocationsUpdateDeviceRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Locations - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -L = Locations() -payload = '{"name":"Test Location2","address":"123 Some Street","address2":"Suite 2","state":"GA","country":"US","zip":"30328"}' -r = L.updateLocation(server, token, "864", payload) -print r diff --git a/ModelsDeleteRequestExample.py b/ModelsDeleteRequestExample.py deleted file mode 100755 index 51ed072..0000000 --- a/ModelsDeleteRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Models - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -M = Models() -r = M.delete(server, token, "13") -print r diff --git a/ModelsGetIDRequestExample.py b/ModelsGetIDRequestExample.py deleted file mode 100755 index c884c97..0000000 --- a/ModelsGetIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Models - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -M = Models() -r = M.getID(server, token, "testModel") -print r diff --git a/ModelsGetRequestExample.py b/ModelsGetRequestExample.py deleted file mode 100755 index c99216e..0000000 --- a/ModelsGetRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Models - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -M = Models() -#r = A.get(server, token, 5) # With a limit of results -r = M.get(server, token) # Using default limit of 50 for results -print r diff --git a/ModelsPostRequestExample.py b/ModelsPostRequestExample.py deleted file mode 100755 index 4777105..0000000 --- a/ModelsPostRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Models - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - -M = Models() -payload = '{"name":"testModel", "category_id":"3", "manufacturer_id":"2"}' -r = M.create(server, token, payload) -print r diff --git a/ModelsUpdateDeviceRequestExample.py b/ModelsUpdateDeviceRequestExample.py deleted file mode 100755 index bcd68ec..0000000 --- a/ModelsUpdateDeviceRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Models - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -M = Models() -payload = '{"id":"13","name":"testModel","category_id":"5","manufacturer_id":"2"}' -r = M.updateModel(server, token, "13", payload) -print r diff --git a/StatusLabelsDeleteRequestExample.py b/StatusLabelsDeleteRequestExample.py deleted file mode 100755 index 5ee3c80..0000000 --- a/StatusLabelsDeleteRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import StatusLabels - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -S = StatusLabels() -r = S.delete(server, token, "7") -print r diff --git a/StatusLabelsGetIDRequestExample.py b/StatusLabelsGetIDRequestExample.py deleted file mode 100755 index 7fc5096..0000000 --- a/StatusLabelsGetIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import StatusLabels - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -S = StatusLabels() -r = S.getID(server, token, "Powered Off") -print r diff --git a/StatusLabelsGetRequestExample.py b/StatusLabelsGetRequestExample.py deleted file mode 100755 index dd41292..0000000 --- a/StatusLabelsGetRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import StatusLabels - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -S = StatusLabels() -#r = A.get(server, token, 5) # With a limit of results -r = S.get(server, token) # Using default limit of 50 for results -print r diff --git a/StatusLabelsPostRequestExample.py b/StatusLabelsPostRequestExample.py deleted file mode 100755 index 5301160..0000000 --- a/StatusLabelsPostRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import StatusLabels - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - -S = StatusLabels() -payload = '{"name":"thisisunique17", "type":"deployable"}' -r = S.create(server, token, payload) -print r diff --git a/StatusLabelsUpdateDeviceRequestExample.py b/StatusLabelsUpdateDeviceRequestExample.py deleted file mode 100755 index 6f2306c..0000000 --- a/StatusLabelsUpdateDeviceRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import StatusLabels - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -S = StatusLabels() -payload = '{"id":"7","name":"thisisunique17","type":"archived"}' -r = S.updateStatusLabel(server, token, "7", payload) -print r diff --git a/UserDeleteRequestExample.py b/UserDeleteRequestExample.py deleted file mode 100755 index 3cb78fa..0000000 --- a/UserDeleteRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Users - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -U = Users() -r = U.delete(server, token, "2358") -print r diff --git a/UsersGetAssetsRequestExample.py b/UsersGetAssetsRequestExample.py deleted file mode 100755 index 43a5993..0000000 --- a/UsersGetAssetsRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Users - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -U = Users() -#r = U.get(server, token, 5) # With a limit of results -r = U.getCheckedOutAssets(server, token, "2346") # Using default limit of 50 for results -print r diff --git a/UsersGetIDRequestExample.py b/UsersGetIDRequestExample.py deleted file mode 100755 index 35268cc..0000000 --- a/UsersGetIDRequestExample.py +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Users - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -U = Users() -r = U.getID(server, token, "test_user1") -print r diff --git a/UsersGetRequestExample.py b/UsersGetRequestExample.py deleted file mode 100755 index bebaae0..0000000 --- a/UsersGetRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Users - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -U = Users() -#r = U.get(server, token, 5) # With a limit of results -r = U.get(server, token) # Using default limit of 50 for results -print r diff --git a/UsersPostRequestExample.py b/UsersPostRequestExample.py deleted file mode 100755 index 9e272fe..0000000 --- a/UsersPostRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Users - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - -U = Users() -# Refer to https://snipe-it.readme.io/v4.0/reference#users-2 for fields -payload = '{"username":"test_user1","first_name":"Test","password":"testing123"}' -r = U.create(server, token, payload) -print r diff --git a/UsersUpdateUserRequestExample.py b/UsersUpdateUserRequestExample.py deleted file mode 100755 index 2f891e2..0000000 --- a/UsersUpdateUserRequestExample.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python - -from snipeit import Users - -server='http://snipeitserver.example.com' -token='eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjU5MjFlNDUxZDlkZGJjNjIyOWIyZGQxYzRkNzMyMTE0MzcyZTY2YTZmMmE5NTE2ZTMyNWM2Mzg2ODNjMjdlODMyODE4YmJmM2QxNTg4MjlhIn0.eyJhdWQiOiIxIiwianRpIjoiNTkyMWU0NTFkOWRkYmM2MjI5YjJkZDFjNGQ3MzIxMTQzNzJlNjZhNmYyYTk1MTZlMzI1YzYzODY4M2MyN2U4MzI4MThiYmYzZDE1ODgyOWEiLCJpYXQiOjE1MTUxODI1OTcsIm5iZiI6MTUxNTE4MjU5NywiZXhwIjoxNTQ2NzE4NTk3LCJzdWIiOiIyMzQ2Iiwic2NvcGVzIjpbXX0.E4aHV0NQDlylBXfkfexYl2UBr043wb2suoNrLD2dSwwptIFxNyy8NSWFQxgvYtVeenIbva9dUhI_dYkY7h0W56RZW3DAoqOlzKjFUnhDU3FEqBMsI-CuiGQPwVJ5QQRIzP9VZVpypqokOf-OTZyc-ZyxyGnqz9_dqMFySYZ7EicbtpdYvWVgelK5HF4gxodeBmLm7igVSNkRm_SxHesyjVIvsefnXFF5idUWSwHBn3jXhv-Jm0fhAz8xAw7XjsXMPQXGMAkQHXYpEmobiGSJsvlVPyf4aZjB7FJVzz-1EecFOqBMAS5ZE4YUYi-DOH4YtS6JL_54UOJMeJ3gPh22f4_3yzjNoZ20_ru_O4au2yraG7INCc53XyFj2qgfh9n9eKqRJH2pTB_5jemMCVLjZRDhXA7H0pMxGr_iSlWCXcJGpXjTtW3au53zlqXxgSYtYuti_pU5rahcQWgKEyh7QGdepOa-xaXG_td5pJs2ewmW1Qw3YfFw1ryVZICnloYrGwnoIehXH_7gCBpuUx-NhlKEzhXEQlV0Vcq_btKB5M-AdPD7XSP4Y5SaTmC8B38J6h-uT5cw8XAUv0vR0NMfY9gs-JXZExTqzVcu_GIhy1v_lkeeh7Xud8ZzSlvR6zdDN3LTxh1IReHZBEX8gSh7bFsGe-bGTp40S_RbSilF_pg' - - -U = Users() -payload = '{"last_name":"Case"}' -r = U.updateUser(server, token, "2358", payload) -print r diff --git a/doc/snipeit/Accessories.html b/doc/snipeit/Accessories.html deleted file mode 100644 index 11bfbeb..0000000 --- a/doc/snipeit/Accessories.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Accessories

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Accessories(object):
-    """Class to access accessories API.    
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, offset=None):
-        """Get list of accessories
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned from the server (default: {50})
-        
-        Returns:
-            string -- List of accessories from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/accessories?limit={0}'.format(str(limit))
-            if offset is not None:
-                self.uri = self.uri + '&offset={0}'.format(str(offset))
-        else:
-            self.uri = '/api/v1/accessories'
-            if offset is not None:
-                self.uri = self.uri + '?offset={0}'.format(str(offset))            
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        
-    def search(self, server, token, limit=None, order='asc', keyword=None):
-        """Get list of accessories based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of accessories in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/accessories?limit={0}&order={1}'.format(str(limit),order)            
-        else:
-            self.uri = '/api/v1/accessories?order={0}'.format(order)               
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new accessories data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Accessories input parameters
-        
-        Returns:
-            string -- data creation result
-        """
-        self.uri = '/api/v1/accessories'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, accessoriesID):
-        """Get the details of accessory data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            accessories_ID {integer} -- ID of the accessories to be found
-        
-        Returns:
-            string -- Detailed information of an accessory
-        """
-        self.uri = '/api/v1/accessories/'
-        self.server = server + self.uri + str(accessoriesID)
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)        
-        return results.content
-   
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Accessories -
-
-

Class to access accessories API.

-
-Source code -
class Accessories(object):
-    """Class to access accessories API.    
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, offset=None):
-        """Get list of accessories
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned from the server (default: {50})
-        
-        Returns:
-            string -- List of accessories from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/accessories?limit={0}'.format(str(limit))
-            if offset is not None:
-                self.uri = self.uri + '&offset={0}'.format(str(offset))
-        else:
-            self.uri = '/api/v1/accessories'
-            if offset is not None:
-                self.uri = self.uri + '?offset={0}'.format(str(offset))            
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        
-    def search(self, server, token, limit=None, order='asc', keyword=None):
-        """Get list of accessories based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of accessories in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/accessories?limit={0}&order={1}'.format(str(limit),order)            
-        else:
-            self.uri = '/api/v1/accessories?order={0}'.format(order)               
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new accessories data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Accessories input parameters
-        
-        Returns:
-            string -- data creation result
-        """
-        self.uri = '/api/v1/accessories'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, accessoriesID):
-        """Get the details of accessory data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            accessories_ID {integer} -- ID of the accessories to be found
-        
-        Returns:
-            string -- Detailed information of an accessory
-        """
-        self.uri = '/api/v1/accessories/'
-        self.server = server + self.uri + str(accessoriesID)
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)        
-        return results.content
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new accessories data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Accessories input parameters

-

Returns

-
-
stringdata creation result
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new accessories data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Accessories input parameters
-    
-    Returns:
-        string -- data creation result
-    """
-    self.uri = '/api/v1/accessories'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def get(self, server, token, limit=None, offset=None) -
-
-

Get list of accessories

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -offset {string} – Starting offset to get the data -Keyword Arguments: -limit {string} – Limit the number of data returned from the server (default: {50})

-

Returns

-
-
stringList of accessories from the server, in JSON formatted
-
 
-
-
-Source code -
def get(self, server, token, limit=None, offset=None):
-    """Get list of accessories
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        offset {string} -- Starting offset to get the data
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned from the server (default: {50})
-    
-    Returns:
-        string -- List of accessories from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/accessories?limit={0}'.format(str(limit))
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-    else:
-        self.uri = '/api/v1/accessories'
-        if offset is not None:
-            self.uri = self.uri + '?offset={0}'.format(str(offset))            
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, accessoriesID) -
-
-

Get the details of accessory data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -accessories_ID {integer} – ID of the accessories to be found

-

Returns

-
-
stringDetailed information of an accessory
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, accessoriesID):
-    """Get the details of accessory data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        accessories_ID {integer} -- ID of the accessories to be found
-    
-    Returns:
-        string -- Detailed information of an accessory
-    """
-    self.uri = '/api/v1/accessories/'
-    self.server = server + self.uri + str(accessoriesID)
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)        
-    return results.content
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None) -
-
-

Get list of accessories based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of accessories in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None):
-    """Get list of accessories based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of accessories in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/accessories?limit={0}&order={1}'.format(str(limit),order)            
-    else:
-        self.uri = '/api/v1/accessories?order={0}'.format(order)               
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Assets.html b/doc/snipeit/Assets.html deleted file mode 100644 index e2644b7..0000000 --- a/doc/snipeit/Assets.html +++ /dev/null @@ -1,1829 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Assets

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-
-class Assets(object):
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))     
-        self.server = server + self.uri 
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of assets based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            string -- List of assets in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri  + '&search=' + keyword
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-    
-    def getAssetsByModel(self, server, token, modelID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            modelID {string} -- Model ID to be limited to     
-            offset {string} -- Starting offset to get the data       
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri 
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAssetsByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoryID {string} -- Category ID to be limited to         
-            offset {string} -- Starting offset to get the data   
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri + '&category_id=' + str(categoryID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAssetsByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturerID {string} -- Manufacturer ID to be limited to   
-            offset {string} -- Starting offset to get the data         
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))         
-        self.server = server + self.uri + '&manufacturer_id={0}'.format(manufacturerID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAssetsByCompany(self, server, token, companyID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API            
-            companyID {string} -- CompanyID to be limited to
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))         
-        self.server = server + self.uri + '&company_id={0}'.format(companyID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content        
-
-    def getAssetsByLocation(self, server, token, locationID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API            
-            locationID {string} -- Location ID to be limited to
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))        
-        self.server = server + self.uri + '&location_id={0}'.format(locationID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAssetsByStatus(self, server, token, status, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API            
-            status {string} -- Status types (RTD, Deployed, Undeployable, Deleted, Archived, Requestable)
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))          
-        self.server = server + self.uri + '&status={0}'.format(status)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content  
-
-    def getAssetsByStatusLabel(self, server, token, statusLabelID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API            
-            statusLabelID {string} -- Status label ID
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware' + '?order=' + order
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))           
-        self.server = server + self.uri + '&status_id={0}'.format(statusLabelID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getDetailsByID(self, server, token, AssetID):
-        """Get asset details by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            AssetID {string} -- Asset ID             
-        
-        Returns:
-            [string] -- Asset details from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/hardware/{0}'.format(str(AssetID))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getDetailsByTag(self, server, token, AssetTAG):
-        """Get asset details by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            AssetTAG {string} -- Asset TAG             
-        
-        Returns:
-            [string] -- Asset details from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/hardware/bytag/{0}'.format(str(AssetTAG))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-
-    def getDetailsBySerial(self, server, token, AssetSerial):
-        """Get asset details by Serial Number
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            AssetSerial {string} -- Asset Serial Number             
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/hardware/byserial/{0}'.format(str(AssetSerial))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new asset data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Asset data
-        
-        Returns:
-            [string] -- Server response in JSON formatted
-        """
-        self.uri = '/api/v1/hardware'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getID(self, server, token, asset_name):
-        """search asset ID by its name
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            asset_name {string} -- Asset name
-        
-        Returns:
-            [string] -- Server response in JSON formatted
-        """                
-        self.uri = '/api/v1/hardware?search={0}'.format(asset_name)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        jsonData = json.loads((results.content).decode('utf-8').replace("'",'"'))
-        #print(jsonData)
-        if len(jsonData['rows']) < 2 and jsonData['rows'][0]['id'] is not None:
-            AssetID = jsonData['rows'][0]['id']
-        return AssetID
-    
-    def delete(self, server, token, DeviceID):
-        """Delete asset data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            DeviceID {string} -- Asset ID to be deleted
-        
-        Returns:
-            [string] -- Server response in JSON formatted
-        """        
-        self.uri = '/api/v1/hardware/{0}'.format(DeviceID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updateDevice(self, server, token, DeviceID, payload):
-        """Update asset data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            DeviceID {string} -- Asset ID
-            payload {string} -- Asset data
-        
-        Returns:
-            [string] -- Server response in JSON formatted
-        """
-        self.uri = '/api/v1/hardware/{0}'.format(DeviceID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def checkInAsset(self, server, token, assetID, note=None, locationID=None):
-        """Check in an asset
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            assetID {string} -- ID of the asset
-        
-        Keyword Arguments:
-            note {string} -- Note of the checkin (default: {None})
-            locationID {string} -- Location id where the asset checked in (default: {None})
-        """
-        self.uri = ('/api/v1/hardware/{0}/checkin'.format(assetID))
-        payload  = {'note':note, 'location_id':locationID}
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-        
-    def checkOutAsset(self, server, token, assetID, note=None, locationID=None):
-        """Check out an asset
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            assetID {string} -- ID of the asset
-        
-        Keyword Arguments:
-            note {string} -- Note of the checkin (default: {None})
-            locationID {string} -- Location id where the asset checked out (default: {None})
-        """
-        self.uri = ('/api/v1/hardware/{0}/checkout'.format(assetID))
-        payload  = {'note':note, 'location_id':locationID}
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def auditAsset(self, server, token, assetTag=None, locationID=None):
-        """Audit an asset
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            assetTag {string} -- asset tag to be audited (default: {None})
-            locationID {[type]} -- location ID to be audited (default: {None})
-        """
-        self.uri = '/api/v1/hardware/audit'
-        payload  = {'asset_tag':assetTag, 'location_id':locationID}
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))        
-
-    def getAuditDue(self, server, token):
-        """Gets list of audit dues
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        """
-        self.uri = '/api/v1/hardware/audit/due' 
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAuditOverdue(self, server, token):
-        """Gets list of audit overdues
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        """
-        self.uri = '/api/v1/hardware/audit/overdue' 
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Assets -
-
-
-
-Source code -
class Assets(object):
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))     
-        self.server = server + self.uri 
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of assets based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            string -- List of assets in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri  + '&search=' + keyword
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-    
-    def getAssetsByModel(self, server, token, modelID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            modelID {string} -- Model ID to be limited to     
-            offset {string} -- Starting offset to get the data       
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri 
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAssetsByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoryID {string} -- Category ID to be limited to         
-            offset {string} -- Starting offset to get the data   
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri + '&category_id=' + str(categoryID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAssetsByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturerID {string} -- Manufacturer ID to be limited to   
-            offset {string} -- Starting offset to get the data         
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))         
-        self.server = server + self.uri + '&manufacturer_id={0}'.format(manufacturerID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAssetsByCompany(self, server, token, companyID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API            
-            companyID {string} -- CompanyID to be limited to
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))         
-        self.server = server + self.uri + '&company_id={0}'.format(companyID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content        
-
-    def getAssetsByLocation(self, server, token, locationID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API            
-            locationID {string} -- Location ID to be limited to
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))        
-        self.server = server + self.uri + '&location_id={0}'.format(locationID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAssetsByStatus(self, server, token, status, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API            
-            status {string} -- Status types (RTD, Deployed, Undeployable, Deleted, Archived, Requestable)
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))          
-        self.server = server + self.uri + '&status={0}'.format(status)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content  
-
-    def getAssetsByStatusLabel(self, server, token, statusLabelID, limit=None, order='asc', offset=None):
-        """Get list of assets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API            
-            statusLabelID {string} -- Status label ID
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/hardware' + '?order=' + order
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))           
-        self.server = server + self.uri + '&status_id={0}'.format(statusLabelID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getDetailsByID(self, server, token, AssetID):
-        """Get asset details by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            AssetID {string} -- Asset ID             
-        
-        Returns:
-            [string] -- Asset details from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/hardware/{0}'.format(str(AssetID))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getDetailsByTag(self, server, token, AssetTAG):
-        """Get asset details by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            AssetTAG {string} -- Asset TAG             
-        
-        Returns:
-            [string] -- Asset details from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/hardware/bytag/{0}'.format(str(AssetTAG))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-
-    def getDetailsBySerial(self, server, token, AssetSerial):
-        """Get asset details by Serial Number
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            AssetSerial {string} -- Asset Serial Number             
-        
-        Returns:
-            [string] -- List of assets from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/hardware/byserial/{0}'.format(str(AssetSerial))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new asset data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Asset data
-        
-        Returns:
-            [string] -- Server response in JSON formatted
-        """
-        self.uri = '/api/v1/hardware'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getID(self, server, token, asset_name):
-        """search asset ID by its name
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            asset_name {string} -- Asset name
-        
-        Returns:
-            [string] -- Server response in JSON formatted
-        """                
-        self.uri = '/api/v1/hardware?search={0}'.format(asset_name)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        jsonData = json.loads((results.content).decode('utf-8').replace("'",'"'))
-        #print(jsonData)
-        if len(jsonData['rows']) < 2 and jsonData['rows'][0]['id'] is not None:
-            AssetID = jsonData['rows'][0]['id']
-        return AssetID
-    
-    def delete(self, server, token, DeviceID):
-        """Delete asset data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            DeviceID {string} -- Asset ID to be deleted
-        
-        Returns:
-            [string] -- Server response in JSON formatted
-        """        
-        self.uri = '/api/v1/hardware/{0}'.format(DeviceID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updateDevice(self, server, token, DeviceID, payload):
-        """Update asset data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            DeviceID {string} -- Asset ID
-            payload {string} -- Asset data
-        
-        Returns:
-            [string] -- Server response in JSON formatted
-        """
-        self.uri = '/api/v1/hardware/{0}'.format(DeviceID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def checkInAsset(self, server, token, assetID, note=None, locationID=None):
-        """Check in an asset
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            assetID {string} -- ID of the asset
-        
-        Keyword Arguments:
-            note {string} -- Note of the checkin (default: {None})
-            locationID {string} -- Location id where the asset checked in (default: {None})
-        """
-        self.uri = ('/api/v1/hardware/{0}/checkin'.format(assetID))
-        payload  = {'note':note, 'location_id':locationID}
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-        
-    def checkOutAsset(self, server, token, assetID, note=None, locationID=None):
-        """Check out an asset
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            assetID {string} -- ID of the asset
-        
-        Keyword Arguments:
-            note {string} -- Note of the checkin (default: {None})
-            locationID {string} -- Location id where the asset checked out (default: {None})
-        """
-        self.uri = ('/api/v1/hardware/{0}/checkout'.format(assetID))
-        payload  = {'note':note, 'location_id':locationID}
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def auditAsset(self, server, token, assetTag=None, locationID=None):
-        """Audit an asset
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            assetTag {string} -- asset tag to be audited (default: {None})
-            locationID {[type]} -- location ID to be audited (default: {None})
-        """
-        self.uri = '/api/v1/hardware/audit'
-        payload  = {'asset_tag':assetTag, 'location_id':locationID}
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))        
-
-    def getAuditDue(self, server, token):
-        """Gets list of audit dues
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        """
-        self.uri = '/api/v1/hardware/audit/due' 
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getAuditOverdue(self, server, token):
-        """Gets list of audit overdues
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        """
-        self.uri = '/api/v1/hardware/audit/overdue' 
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-

Methods

-
-
-def auditAsset(self, server, token, assetTag=None, locationID=None) -
-
-

Audit an asset

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -assetTag {string} – asset tag to be audited (default: {None}) -locationID {[type]} – location ID to be audited (default: {None})

-
-Source code -
def auditAsset(self, server, token, assetTag=None, locationID=None):
-    """Audit an asset
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        assetTag {string} -- asset tag to be audited (default: {None})
-        locationID {[type]} -- location ID to be audited (default: {None})
-    """
-    self.uri = '/api/v1/hardware/audit'
-    payload  = {'asset_tag':assetTag, 'location_id':locationID}
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))        
-
-
-
-def checkInAsset(self, server, token, assetID, note=None, locationID=None) -
-
-

Check in an asset

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -assetID {string} – ID of the asset -Keyword Arguments: -note {string} – Note of the checkin (default: {None}) -locationID {string} – Location id where the asset checked in (default: {None})

-
-Source code -
def checkInAsset(self, server, token, assetID, note=None, locationID=None):
-    """Check in an asset
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        assetID {string} -- ID of the asset
-    
-    Keyword Arguments:
-        note {string} -- Note of the checkin (default: {None})
-        locationID {string} -- Location id where the asset checked in (default: {None})
-    """
-    self.uri = ('/api/v1/hardware/{0}/checkin'.format(assetID))
-    payload  = {'note':note, 'location_id':locationID}
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def checkOutAsset(self, server, token, assetID, note=None, locationID=None) -
-
-

Check out an asset

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -assetID {string} – ID of the asset -Keyword Arguments: -note {string} – Note of the checkin (default: {None}) -locationID {string} – Location id where the asset checked out (default: {None})

-
-Source code -
def checkOutAsset(self, server, token, assetID, note=None, locationID=None):
-    """Check out an asset
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        assetID {string} -- ID of the asset
-    
-    Keyword Arguments:
-        note {string} -- Note of the checkin (default: {None})
-        locationID {string} -- Location id where the asset checked out (default: {None})
-    """
-    self.uri = ('/api/v1/hardware/{0}/checkout'.format(assetID))
-    payload  = {'note':note, 'location_id':locationID}
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def create(self, server, token, payload) -
-
-

Create new asset data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Asset data

-

Returns

-

[string] – Server response in JSON formatted

-
-Source code -
def create(self, server, token, payload):
-    """Create new asset data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Asset data
-    
-    Returns:
-        [string] -- Server response in JSON formatted
-    """
-    self.uri = '/api/v1/hardware'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, DeviceID) -
-
-

Delete asset data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -DeviceID {string} – Asset ID to be deleted

-

Returns

-

[string] – Server response in JSON formatted

-
-Source code -
def delete(self, server, token, DeviceID):
-    """Delete asset data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        DeviceID {string} -- Asset ID to be deleted
-    
-    Returns:
-        [string] -- Server response in JSON formatted
-    """        
-    self.uri = '/api/v1/hardware/{0}'.format(DeviceID)
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token, limit=None, order='asc', offset=None) -
-
-

Get list of assets

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -offset {string} – Starting offset to get the data -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of assets from the server, in JSON formatted

-
-Source code -
def get(self, server, token, limit=None, order='asc', offset=None):
-    """Get list of assets
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        offset {string} -- Starting offset to get the data
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of assets from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/hardware?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))     
-    self.server = server + self.uri 
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getAssetsByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None) -
-
-

Get list of assets

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -categoryID {string} – Category ID to be limited to -
-offset {string} – Starting offset to get the data
-Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of assets from the server, in JSON formatted

-
-Source code -
def getAssetsByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None):
-    """Get list of assets
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        categoryID {string} -- Category ID to be limited to         
-        offset {string} -- Starting offset to get the data   
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of assets from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/hardware?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))
-    self.server = server + self.uri + '&category_id=' + str(categoryID)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getAssetsByCompany(self, server, token, companyID, limit=None, order='asc', offset=None) -
-
-

Get list of assets

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -
-companyID {string} – CompanyID to be limited to -offset {string} – Starting offset to get the data -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of assets from the server, in JSON formatted

-
-Source code -
def getAssetsByCompany(self, server, token, companyID, limit=None, order='asc', offset=None):
-    """Get list of assets
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API            
-        companyID {string} -- CompanyID to be limited to
-        offset {string} -- Starting offset to get the data
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of assets from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/hardware?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))         
-    self.server = server + self.uri + '&company_id={0}'.format(companyID)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content        
-
-
-
-def getAssetsByLocation(self, server, token, locationID, limit=None, order='asc', offset=None) -
-
-

Get list of assets

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -
-locationID {string} – Location ID to be limited to -offset {string} – Starting offset to get the data -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of assets from the server, in JSON formatted

-
-Source code -
def getAssetsByLocation(self, server, token, locationID, limit=None, order='asc', offset=None):
-    """Get list of assets
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API            
-        locationID {string} -- Location ID to be limited to
-        offset {string} -- Starting offset to get the data
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of assets from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/hardware?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))        
-    self.server = server + self.uri + '&location_id={0}'.format(locationID)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getAssetsByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None) -
-
-

Get list of assets

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -manufacturerID {string} – Manufacturer ID to be limited to
-offset {string} – Starting offset to get the data -
-Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of assets from the server, in JSON formatted

-
-Source code -
def getAssetsByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None):
-    """Get list of assets
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        manufacturerID {string} -- Manufacturer ID to be limited to   
-        offset {string} -- Starting offset to get the data         
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of assets from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/hardware?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))         
-    self.server = server + self.uri + '&manufacturer_id={0}'.format(manufacturerID)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getAssetsByModel(self, server, token, modelID, limit=None, order='asc', offset=None) -
-
-

Get list of assets

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -modelID {string} – Model ID to be limited to -
-offset {string} – Starting offset to get the data -
-Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of assets from the server, in JSON formatted

-
-Source code -
def getAssetsByModel(self, server, token, modelID, limit=None, order='asc', offset=None):
-    """Get list of assets
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        modelID {string} -- Model ID to be limited to     
-        offset {string} -- Starting offset to get the data       
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of assets from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/hardware?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri 
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getAssetsByStatus(self, server, token, status, limit=None, order='asc', offset=None) -
-
-

Get list of assets

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -
-status {string} – Status types (RTD, Deployed, Undeployable, Deleted, Archived, Requestable) -offset {string} – Starting offset to get the data -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of assets from the server, in JSON formatted

-
-Source code -
def getAssetsByStatus(self, server, token, status, limit=None, order='asc', offset=None):
-    """Get list of assets
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API            
-        status {string} -- Status types (RTD, Deployed, Undeployable, Deleted, Archived, Requestable)
-        offset {string} -- Starting offset to get the data
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of assets from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/hardware?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))          
-    self.server = server + self.uri + '&status={0}'.format(status)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content  
-
-
-
-def getAssetsByStatusLabel(self, server, token, statusLabelID, limit=None, order='asc', offset=None) -
-
-

Get list of assets

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -
-statusLabelID {string} – Status label ID -offset {string} – Starting offset to get the data -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of assets from the server, in JSON formatted

-
-Source code -
def getAssetsByStatusLabel(self, server, token, statusLabelID, limit=None, order='asc', offset=None):
-    """Get list of assets
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API            
-        statusLabelID {string} -- Status label ID
-        offset {string} -- Starting offset to get the data
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of assets from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/hardware' + '?order=' + order
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))           
-    self.server = server + self.uri + '&status_id={0}'.format(statusLabelID)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getAuditDue(self, server, token) -
-
-

Gets list of audit dues

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API

-
-Source code -
def getAuditDue(self, server, token):
-    """Gets list of audit dues
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    """
-    self.uri = '/api/v1/hardware/audit/due' 
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getAuditOverdue(self, server, token) -
-
-

Gets list of audit overdues

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API

-
-Source code -
def getAuditOverdue(self, server, token):
-    """Gets list of audit overdues
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    """
-    self.uri = '/api/v1/hardware/audit/overdue' 
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, AssetID) -
-
-

Get asset details by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -AssetID {string} – Asset ID -

-

Returns

-

[string] – Asset details from the server, in JSON formatted

-
-Source code -
def getDetailsByID(self, server, token, AssetID):
-    """Get asset details by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        AssetID {string} -- Asset ID             
-    
-    Returns:
-        [string] -- Asset details from the server, in JSON formatted
-    """
-    self.uri = '/api/v1/hardware/{0}'.format(str(AssetID))
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsBySerial(self, server, token, AssetSerial) -
-
-

Get asset details by Serial Number

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -AssetSerial {string} – Asset Serial Number -

-

Returns

-

[string] – List of assets from the server, in JSON formatted

-
-Source code -
def getDetailsBySerial(self, server, token, AssetSerial):
-    """Get asset details by Serial Number
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        AssetSerial {string} -- Asset Serial Number             
-    
-    Returns:
-        [string] -- List of assets from the server, in JSON formatted
-    """
-    self.uri = '/api/v1/hardware/byserial/{0}'.format(str(AssetSerial))
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByTag(self, server, token, AssetTAG) -
-
-

Get asset details by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -AssetTAG {string} – Asset TAG -

-

Returns

-

[string] – Asset details from the server, in JSON formatted

-
-Source code -
def getDetailsByTag(self, server, token, AssetTAG):
-    """Get asset details by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        AssetTAG {string} -- Asset TAG             
-    
-    Returns:
-        [string] -- Asset details from the server, in JSON formatted
-    """
-    self.uri = '/api/v1/hardware/bytag/{0}'.format(str(AssetTAG))
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getID(self, server, token, asset_name) -
-
-

search asset ID by its name

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -asset_name {string} – Asset name

-

Returns

-

[string] – Server response in JSON formatted

-
-Source code -
def getID(self, server, token, asset_name):
-    """search asset ID by its name
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        asset_name {string} -- Asset name
-    
-    Returns:
-        [string] -- Server response in JSON formatted
-    """                
-    self.uri = '/api/v1/hardware?search={0}'.format(asset_name)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    jsonData = json.loads((results.content).decode('utf-8').replace("'",'"'))
-    #print(jsonData)
-    if len(jsonData['rows']) < 2 and jsonData['rows'][0]['id'] is not None:
-        AssetID = jsonData['rows'][0]['id']
-    return AssetID
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None, offset=None) -
-
-

Get list of assets based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -offset {string} – Starting offset to get the data -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

string – List of assets in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-    """Get list of assets based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        offset {string} -- Starting offset to get the data
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        string -- List of assets in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/hardware?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/hardware?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))
-    self.server = server + self.uri  + '&search=' + keyword
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def updateDevice(self, server, token, DeviceID, payload) -
-
-

Update asset data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -DeviceID {string} – Asset ID -payload {string} – Asset data

-

Returns

-

[string] – Server response in JSON formatted

-
-Source code -
def updateDevice(self, server, token, DeviceID, payload):
-    """Update asset data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        DeviceID {string} -- Asset ID
-        payload {string} -- Asset data
-    
-    Returns:
-        [string] -- Server response in JSON formatted
-    """
-    self.uri = '/api/v1/hardware/{0}'.format(DeviceID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Categories.html b/doc/snipeit/Categories.html deleted file mode 100644 index c40f6ad..0000000 --- a/doc/snipeit/Categories.html +++ /dev/null @@ -1,606 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Categories

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Categories(object):
-    def __init__(self):
-        """Class to access categories API.
-        """
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of categories
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of categories in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/categories?limit={0}'.format(str(limit))
-            if offset is not None:
-                self.uri = self.uri + '&offset={0}'.format(str(offset))
-        else:
-            self.uri = '/api/v1/categories'
-            if offset is not None:
-                self.uri = self.uri + '?offset={0}'.format(str(offset))        
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of categories based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of categories in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/categories?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/categories?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))     
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content        
-
-    def create(self, server, token, payload):
-        """Create new categories data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/categories'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, categoriesID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoriesID {string} -- ID of the categories
-        
-        Returns:
-            string -- Detailed information of categories by ID
-        """
-        self.uri = '/api/v1/categories/{0}'.format(categoriesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, categoriesID):
-        """Delete categories data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoriesID {string} -- ID of the categories
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/categories/{0}'.format(categoriesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updatecategories(self, server, token, categoriesID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoriesID {string} -- ID of the categories
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/categories/{0}'.format(categoriesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Categories -
-
-

Class to access categories API.

-
-Source code -
class Categories(object):
-    def __init__(self):
-        """Class to access categories API.
-        """
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of categories
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of categories in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/categories?limit={0}'.format(str(limit))
-            if offset is not None:
-                self.uri = self.uri + '&offset={0}'.format(str(offset))
-        else:
-            self.uri = '/api/v1/categories'
-            if offset is not None:
-                self.uri = self.uri + '?offset={0}'.format(str(offset))        
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of categories based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-            offset {string} -- Starting offset to get the data
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of categories in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/categories?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/categories?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))     
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content        
-
-    def create(self, server, token, payload):
-        """Create new categories data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/categories'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, categoriesID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoriesID {string} -- ID of the categories
-        
-        Returns:
-            string -- Detailed information of categories by ID
-        """
-        self.uri = '/api/v1/categories/{0}'.format(categoriesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, categoriesID):
-        """Delete categories data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoriesID {string} -- ID of the categories
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/categories/{0}'.format(categoriesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updatecategories(self, server, token, categoriesID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoriesID {string} -- ID of the categories
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/categories/{0}'.format(categoriesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new categories data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new categories data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/categories'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, categoriesID) -
-
-

Delete categories data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -categoriesID {string} – ID of the categories

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def delete(self, server, token, categoriesID):
-    """Delete categories data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        categoriesID {string} -- ID of the categories
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/categories/{0}'.format(categoriesID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token, limit=None, order='asc', offset=None) -
-
-

Get list of categories

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -offset {string} – Starting offset to get the data -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of categories in JSON format.

-
-Source code -
def get(self, server, token, limit=None, order='asc', offset=None):
-    """Get list of categories
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        offset {string} -- Starting offset to get the data
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of categories in JSON format.
-    """
-    if limit is not None:
-        self.uri = '/api/v1/categories?limit={0}'.format(str(limit))
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-    else:
-        self.uri = '/api/v1/categories'
-        if offset is not None:
-            self.uri = self.uri + '?offset={0}'.format(str(offset))        
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, categoriesID) -
-
-

Get detailed information of label by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -categoriesID {string} – ID of the categories

-

Returns

-
-
stringDetailed information of categories by ID
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, categoriesID):
-    """Get detailed information of label by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        categoriesID {string} -- ID of the categories
-    
-    Returns:
-        string -- Detailed information of categories by ID
-    """
-    self.uri = '/api/v1/categories/{0}'.format(categoriesID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)                
-    return results.content
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None, offset=None) -
-
-

Get list of categories based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -offset {string} – Starting offset to get the data -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of categories in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-    """Get list of categories based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-        offset {string} -- Starting offset to get the data
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of categories in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/categories?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/categories?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))     
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content        
-
-
-
-def updatecategories(self, server, token, categoriesID, payload) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -categoriesID {string} – ID of the categories -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def updatecategories(self, server, token, categoriesID, payload):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        categoriesID {string} -- ID of the categories
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/categories/{0}'.format(categoriesID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Company.html b/doc/snipeit/Company.html deleted file mode 100644 index 0cf0364..0000000 --- a/doc/snipeit/Company.html +++ /dev/null @@ -1,464 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Company

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Company(object):
-    """Class to access Companies API
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token):
-        """Gets company list
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Returns:
-            string -- List of companies from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies'
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new company data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Company Name
-        
-        Returns:
-            string -- Status data from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, companiesID):
-        """Gets company details by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            companiesID {[type]} -- [description]
-        
-        Returns:
-            string -- Detailed information of company from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies/{0}'.format(str(companiesID))
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)        
-        return results.content
-
-    def delete(self, server, token, CompanyID):
-        """Delete company information
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            CompanyID {[type]} -- [description]
-        
-        Returns:
-            string -- Response message from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies/{0}'.format(CompanyID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updateCompany(self, server, token, CompanyID, payload):
-        """Updates company name.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            CompanyID {string} -- ID of company to be updated
-            payload {string} -- Company name to be updated
-        
-        Returns:
-            string -- Response message from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies/{0}'.format(CompanyID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Company -
-
-

Class to access Companies API

-
-Source code -
class Company(object):
-    """Class to access Companies API
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token):
-        """Gets company list
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Returns:
-            string -- List of companies from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies'
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new company data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Company Name
-        
-        Returns:
-            string -- Status data from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, companiesID):
-        """Gets company details by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            companiesID {[type]} -- [description]
-        
-        Returns:
-            string -- Detailed information of company from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies/{0}'.format(str(companiesID))
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)        
-        return results.content
-
-    def delete(self, server, token, CompanyID):
-        """Delete company information
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            CompanyID {[type]} -- [description]
-        
-        Returns:
-            string -- Response message from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies/{0}'.format(CompanyID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updateCompany(self, server, token, CompanyID, payload):
-        """Updates company name.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            CompanyID {string} -- ID of company to be updated
-            payload {string} -- Company name to be updated
-        
-        Returns:
-            string -- Response message from the server, in JSON formatted
-        """
-        self.uri = '/api/v1/companies/{0}'.format(CompanyID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new company data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Company Name

-

Returns

-
-
stringStatus data from the server, in JSON formatted
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new company data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Company Name
-    
-    Returns:
-        string -- Status data from the server, in JSON formatted
-    """
-    self.uri = '/api/v1/companies'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, CompanyID) -
-
-

Delete company information

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -CompanyID {[type]} – [description]

-

Returns

-
-
stringResponse message from the server, in JSON formatted
-
 
-
-
-Source code -
def delete(self, server, token, CompanyID):
-    """Delete company information
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        CompanyID {[type]} -- [description]
-    
-    Returns:
-        string -- Response message from the server, in JSON formatted
-    """
-    self.uri = '/api/v1/companies/{0}'.format(CompanyID)
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token) -
-
-

Gets company list

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API

-

Returns

-
-
stringList of companies from the server, in JSON formatted
-
 
-
-
-Source code -
def get(self, server, token):
-    """Gets company list
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Returns:
-        string -- List of companies from the server, in JSON formatted
-    """
-    self.uri = '/api/v1/companies'
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, companiesID) -
-
-

Gets company details by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -companiesID {[type]} – [description]

-

Returns

-
-
stringDetailed information of company from the server, in JSON formatted
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, companiesID):
-    """Gets company details by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        companiesID {[type]} -- [description]
-    
-    Returns:
-        string -- Detailed information of company from the server, in JSON formatted
-    """
-    self.uri = '/api/v1/companies/{0}'.format(str(companiesID))
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)        
-    return results.content
-
-
-
-def updateCompany(self, server, token, CompanyID, payload) -
-
-

Updates company name.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -CompanyID {string} – ID of company to be updated -payload {string} – Company name to be updated

-

Returns

-
-
stringResponse message from the server, in JSON formatted
-
 
-
-
-Source code -
def updateCompany(self, server, token, CompanyID, payload):
-    """Updates company name.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        CompanyID {string} -- ID of company to be updated
-        payload {string} -- Company name to be updated
-    
-    Returns:
-        string -- Response message from the server, in JSON formatted
-    """
-    self.uri = '/api/v1/companies/{0}'.format(CompanyID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Components.html b/doc/snipeit/Components.html deleted file mode 100644 index 9dfbe52..0000000 --- a/doc/snipeit/Components.html +++ /dev/null @@ -1,450 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Components

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Components(object):
-    """Class to access components API  
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', expand=True, offset=None):
-        """Get list of component data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-            expand {boolean} -- Include detailed information or just text name (False)
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of components from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/components?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/components?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri + '&expand={0}'.format(str(expand).lower())
-        print(self.server)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of components based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of components in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/components?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/components?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """create new component data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- name of the component
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/components'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, componentsID):
-        """Get detailed information of component by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            componentsID {string} -- ID of the component
-        
-        Returns:
-            string -- Detailed information of component by ID
-        """
-        self.uri = '/api/v1/components/{0}'.format(componentsID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Components -
-
-

Class to access components API

-
-Source code -
class Components(object):
-    """Class to access components API  
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', expand=True, offset=None):
-        """Get list of component data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-            expand {boolean} -- Include detailed information or just text name (False)
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of components from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/components?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/components?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri + '&expand={0}'.format(str(expand).lower())
-        print(self.server)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of components based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of components in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/components?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/components?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """create new component data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- name of the component
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/components'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, componentsID):
-        """Get detailed information of component by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            componentsID {string} -- ID of the component
-        
-        Returns:
-            string -- Detailed information of component by ID
-        """
-        self.uri = '/api/v1/components/{0}'.format(componentsID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

create new component data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – name of the component

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """create new component data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- name of the component
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/components'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def get(self, server, token, limit=None, order='asc', expand=True, offset=None) -
-
-

Get list of component data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -expand {boolean} – Include detailed information or just text name (False) -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-
-
stringList of components from the server, in JSON formatted
-
 
-
-
-Source code -
def get(self, server, token, limit=None, order='asc', expand=True, offset=None):
-    """Get list of component data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-        expand {boolean} -- Include detailed information or just text name (False)
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of components from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/components?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/components?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri + '&expand={0}'.format(str(expand).lower())
-    print(self.server)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, componentsID) -
-
-

Get detailed information of component by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -componentsID {string} – ID of the component

-

Returns

-
-
stringDetailed information of component by ID
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, componentsID):
-    """Get detailed information of component by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        componentsID {string} -- ID of the component
-    
-    Returns:
-        string -- Detailed information of component by ID
-    """
-    self.uri = '/api/v1/components/{0}'.format(componentsID)
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)                
-    return results.content
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None, offset=None) -
-
-

Get list of components based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of components in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-    """Get list of components based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of components in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/components?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/components?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Consumables.html b/doc/snipeit/Consumables.html deleted file mode 100644 index c33b4b4..0000000 --- a/doc/snipeit/Consumables.html +++ /dev/null @@ -1,829 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Consumables

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Consumables(object):
-    """Class to access consumables API    
-    """    
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of consumables
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri 
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-
-    def getConsumablesByOrder(self, server, token, orderNumber, limit=None, order='asc', offset=None):
-        """Get list of consumables
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            orderNumber {string} -- Order Number to be used as filter
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri 
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getConsumablesByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None):
-        """Get list of consumables
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoryID {string} -- Category ID to be used as filter
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri +'&category_id={0}'.format(categoryID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getConsumablesByCompany(self, server, token, companyID, limit=None, order='asc', offset=None):
-        """Get list of consumables
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            companyID {string} -- Company ID to be used as filter
-            
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri + '&company_id={0}'.format(companyID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getConsumablesByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None):
-        """Get list of consumables filtered by manufacturer ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturerID {string} -- Manufacturer ID to be used as filter
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri +'&manufacturer_id={0}'.format(manufacturerID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of consumables based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of consumables in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new consumable data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- consumable name
-        
-        Returns:
-            [type] -- [description]
-        """
-        self.uri = '/api/v1/consumables'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, consumableID):
-        """Get detailed information of consumables by ID.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            consumableID {string} -- Consumable ID to be checked
-        
-        Returns:
-            string -- detailed information of consumable in JSON
-        """
-        self.uri = '/api/v1/consumables/{0}'.format(consumableID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)        
-        return results.content
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Consumables -
-
-

Class to access consumables API

-
-Source code -
class Consumables(object):
-    """Class to access consumables API    
-    """    
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of consumables
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri 
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-
-    def getConsumablesByOrder(self, server, token, orderNumber, limit=None, order='asc', offset=None):
-        """Get list of consumables
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            orderNumber {string} -- Order Number to be used as filter
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri 
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getConsumablesByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None):
-        """Get list of consumables
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            categoryID {string} -- Category ID to be used as filter
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri +'&category_id={0}'.format(categoryID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getConsumablesByCompany(self, server, token, companyID, limit=None, order='asc', offset=None):
-        """Get list of consumables
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            companyID {string} -- Company ID to be used as filter
-            
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri + '&company_id={0}'.format(companyID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def getConsumablesByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None):
-        """Get list of consumables filtered by manufacturer ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturerID {string} -- Manufacturer ID to be used as filter
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Returns:
-            [string] -- List of consumables from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri +'&manufacturer_id={0}'.format(manufacturerID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of consumables based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of consumables in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/consumables?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new consumable data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- consumable name
-        
-        Returns:
-            [type] -- [description]
-        """
-        self.uri = '/api/v1/consumables'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, consumableID):
-        """Get detailed information of consumables by ID.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            consumableID {string} -- Consumable ID to be checked
-        
-        Returns:
-            string -- detailed information of consumable in JSON
-        """
-        self.uri = '/api/v1/consumables/{0}'.format(consumableID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)        
-        return results.content
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new consumable data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – consumable name

-

Returns

-

[type] – [description]

-
-Source code -
def create(self, server, token, payload):
-    """Create new consumable data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- consumable name
-    
-    Returns:
-        [type] -- [description]
-    """
-    self.uri = '/api/v1/consumables'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def get(self, server, token, limit=None, order='asc', offset=None) -
-
-

Get list of consumables

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of consumables from the server, in JSON formatted

-
-Source code -
def get(self, server, token, limit=None, order='asc', offset=None):
-    """Get list of consumables
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of consumables from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/consumables?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri 
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getConsumablesByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None) -
-
-

Get list of consumables

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -categoryID {string} – Category ID to be used as filter -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of consumables from the server, in JSON formatted

-
-Source code -
def getConsumablesByCategory(self, server, token, categoryID, limit=None, order='asc', offset=None):
-    """Get list of consumables
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        categoryID {string} -- Category ID to be used as filter
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of consumables from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/consumables?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri +'&category_id={0}'.format(categoryID)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getConsumablesByCompany(self, server, token, companyID, limit=None, order='asc', offset=None) -
-
-

Get list of consumables

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -companyID {string} – Company ID to be used as filter -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of consumables from the server, in JSON formatted

-
-Source code -
def getConsumablesByCompany(self, server, token, companyID, limit=None, order='asc', offset=None):
-    """Get list of consumables
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        companyID {string} -- Company ID to be used as filter
-        
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of consumables from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/consumables?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri + '&company_id={0}'.format(companyID)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getConsumablesByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None) -
-
-

Get list of consumables filtered by manufacturer ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -manufacturerID {string} – Manufacturer ID to be used as filter -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of consumables from the server, in JSON formatted

-
-Source code -
def getConsumablesByManufacturer(self, server, token, manufacturerID, limit=None, order='asc', offset=None):
-    """Get list of consumables filtered by manufacturer ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        manufacturerID {string} -- Manufacturer ID to be used as filter
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of consumables from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/consumables?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri +'&manufacturer_id={0}'.format(manufacturerID)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getConsumablesByOrder(self, server, token, orderNumber, limit=None, order='asc', offset=None) -
-
-

Get list of consumables

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -orderNumber {string} – Order Number to be used as filter -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50}) -order {string} – Display order of data (asc / desc default:{asc})

-

Returns

-

[string] – List of consumables from the server, in JSON formatted

-
-Source code -
def getConsumablesByOrder(self, server, token, orderNumber, limit=None, order='asc', offset=None):
-    """Get list of consumables
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        orderNumber {string} -- Order Number to be used as filter
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Returns:
-        [string] -- List of consumables from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/consumables?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri 
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, consumableID) -
-
-

Get detailed information of consumables by ID.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -consumableID {string} – Consumable ID to be checked

-

Returns

-
-
stringdetailed information of consumable in JSON
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, consumableID):
-    """Get detailed information of consumables by ID.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        consumableID {string} -- Consumable ID to be checked
-    
-    Returns:
-        string -- detailed information of consumable in JSON
-    """
-    self.uri = '/api/v1/consumables/{0}'.format(consumableID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)        
-    return results.content
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None, offset=None) -
-
-

Get list of consumables based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of consumables in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-    """Get list of consumables based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of consumables in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/consumables?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/consumables?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Fieldsets.html b/doc/snipeit/Fieldsets.html deleted file mode 100644 index f31de52..0000000 --- a/doc/snipeit/Fieldsets.html +++ /dev/null @@ -1,472 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Fieldsets

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Fieldsets(object):
-    def __init__(self):
-        pass
-
-    def get(self, server, token):
-        """Get list of fieldsets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of fieldsets in JSON format.
-        """       
-        self.uri = '/api/v1/fields'  
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def create(self, server, token, payload):
-        """Create new fieldsets data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/fieldsets'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, fieldsetsID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            fieldsetsID {string} -- ID of the fieldsets
-        
-        Returns:
-            string -- Detailed information of fieldsets by ID
-        """
-        self.uri = '/api/v1/fieldsets/{0}'.format(fieldsetsID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, fieldsetsID):
-        """Delete fieldsets data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            fieldsetsID {string} -- ID of the fieldsets
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/fieldsets/{0}'.format(fieldsetsID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updatefieldsets(self, server, token, fieldsetsID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            fieldsetsID {string} -- ID of the fieldsets
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/fieldsets/{0}'.format(fieldsetsID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Fieldsets -
-
-
-
-Source code -
class Fieldsets(object):
-    def __init__(self):
-        pass
-
-    def get(self, server, token):
-        """Get list of fieldsets
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of fieldsets in JSON format.
-        """       
-        self.uri = '/api/v1/fields'  
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def create(self, server, token, payload):
-        """Create new fieldsets data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/fieldsets'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, fieldsetsID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            fieldsetsID {string} -- ID of the fieldsets
-        
-        Returns:
-            string -- Detailed information of fieldsets by ID
-        """
-        self.uri = '/api/v1/fieldsets/{0}'.format(fieldsetsID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, fieldsetsID):
-        """Delete fieldsets data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            fieldsetsID {string} -- ID of the fieldsets
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/fieldsets/{0}'.format(fieldsetsID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updatefieldsets(self, server, token, fieldsetsID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            fieldsetsID {string} -- ID of the fieldsets
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/fieldsets/{0}'.format(fieldsetsID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new fieldsets data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new fieldsets data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/fieldsets'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, fieldsetsID) -
-
-

Delete fieldsets data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -fieldsetsID {string} – ID of the fieldsets

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def delete(self, server, token, fieldsetsID):
-    """Delete fieldsets data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        fieldsetsID {string} -- ID of the fieldsets
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/fieldsets/{0}'.format(fieldsetsID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token) -
-
-

Get list of fieldsets

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of fieldsets in JSON format.

-
-Source code -
def get(self, server, token):
-    """Get list of fieldsets
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of fieldsets in JSON format.
-    """       
-    self.uri = '/api/v1/fields'  
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, fieldsetsID) -
-
-

Get detailed information of label by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -fieldsetsID {string} – ID of the fieldsets

-

Returns

-
-
stringDetailed information of fieldsets by ID
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, fieldsetsID):
-    """Get detailed information of label by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        fieldsetsID {string} -- ID of the fieldsets
-    
-    Returns:
-        string -- Detailed information of fieldsets by ID
-    """
-    self.uri = '/api/v1/fieldsets/{0}'.format(fieldsetsID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)                
-    return results.content
-
-
-
-def updatefieldsets(self, server, token, fieldsetsID, payload) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -fieldsetsID {string} – ID of the fieldsets -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def updatefieldsets(self, server, token, fieldsetsID, payload):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        fieldsetsID {string} -- ID of the fieldsets
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/fieldsets/{0}'.format(fieldsetsID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Licenses.html b/doc/snipeit/Licenses.html deleted file mode 100644 index 49af9f0..0000000 --- a/doc/snipeit/Licenses.html +++ /dev/null @@ -1,596 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Licenses

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Licenses(object):
-    def __init__(self):
-        """Class to access licenses API.
-        """
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of licenses
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of licenses in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/licenses?limit={0}&order={1}'.format(str(limit) ,order)
-        else:
-            self.uri = '/api/v1/licenses?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))         
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of licenses based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of licenses in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/licenses?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/licenses?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new licenses data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/licenses'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, licensesID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            licensesID {string} -- ID of the licenses
-        
-        Returns:
-            string -- Detailed information of licenses by ID
-        """
-        self.uri = '/api/v1/licenses/{0}'.format(licensesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, licensesID):
-        """Delete licenses data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            licensesID {string} -- ID of the licenses
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/licenses/{0}'.format(licensesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updatelicenses(self, server, token, licensesID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            licensesID {string} -- ID of the licenses
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/licenses/{0}'.format(licensesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Licenses -
-
-

Class to access licenses API.

-
-Source code -
class Licenses(object):
-    def __init__(self):
-        """Class to access licenses API.
-        """
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of licenses
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of licenses in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/licenses?limit={0}&order={1}'.format(str(limit) ,order)
-        else:
-            self.uri = '/api/v1/licenses?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))         
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of licenses based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of licenses in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/licenses?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/licenses?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new licenses data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/licenses'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, licensesID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            licensesID {string} -- ID of the licenses
-        
-        Returns:
-            string -- Detailed information of licenses by ID
-        """
-        self.uri = '/api/v1/licenses/{0}'.format(licensesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, licensesID):
-        """Delete licenses data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            licensesID {string} -- ID of the licenses
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/licenses/{0}'.format(licensesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updatelicenses(self, server, token, licensesID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            licensesID {string} -- ID of the licenses
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/licenses/{0}'.format(licensesID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new licenses data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new licenses data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/licenses'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, licensesID) -
-
-

Delete licenses data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -licensesID {string} – ID of the licenses

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def delete(self, server, token, licensesID):
-    """Delete licenses data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        licensesID {string} -- ID of the licenses
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/licenses/{0}'.format(licensesID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token, limit=None, order='asc', offset=None) -
-
-

Get list of licenses

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of licenses in JSON format.

-
-Source code -
def get(self, server, token, limit=None, order='asc', offset=None):
-    """Get list of licenses
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of licenses in JSON format.
-    """
-    if limit is not None:
-        self.uri = '/api/v1/licenses?limit={0}&order={1}'.format(str(limit) ,order)
-    else:
-        self.uri = '/api/v1/licenses?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))         
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, licensesID) -
-
-

Get detailed information of label by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -licensesID {string} – ID of the licenses

-

Returns

-
-
stringDetailed information of licenses by ID
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, licensesID):
-    """Get detailed information of label by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        licensesID {string} -- ID of the licenses
-    
-    Returns:
-        string -- Detailed information of licenses by ID
-    """
-    self.uri = '/api/v1/licenses/{0}'.format(licensesID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)                
-    return results.content
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None, offset=None) -
-
-

Get list of licenses based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of licenses in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-    """Get list of licenses based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of licenses in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/licenses?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/licenses?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def updatelicenses(self, server, token, licensesID, payload) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -licensesID {string} – ID of the licenses -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def updatelicenses(self, server, token, licensesID, payload):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        licensesID {string} -- ID of the licenses
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/licenses/{0}'.format(licensesID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Locations.html b/doc/snipeit/Locations.html deleted file mode 100644 index 85eafa6..0000000 --- a/doc/snipeit/Locations.html +++ /dev/null @@ -1,591 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Locations

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Locations(object):
-    """Class to access Location API    
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None,order='asc', offset=None):
-        """Get list of locations.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of locations from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/locations?limit={0}'.format(str(limit))
-            if offset is not None:
-                self.uri = self.uri + '&offset={0}'.format(str(offset))
-        else:
-            self.uri = '/api/v1/locations'
-            if offset is not None:
-                self.uri = self.uri + '?offset={0}'.format(str(offset))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def search(self, server, token, limit=None, order='asc', keyword=None):
-        """Get list of locations based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of locations in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/locations?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/locations?order={0}'.format(order)                  
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new location data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- Server response in JSON
-        """
-        self.uri = '/api/v1/locations'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, locationID):
-        """Get detailed location information by ID.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            locationID {string} -- Location ID to be searched
-        
-        Returns:
-            string -- Detailed information of a location
-        """
-        self.uri = '/api/v1/locations/{0}'.format(locationID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)        
-        return results.content
-
-    def updateLocation(self, server, token, LocationID, payload):
-        """Update location data information
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            LocationID {string} -- ID of the location to be updated
-            payload {string} -- input parameters
-        
-        Returns:
-            string -- response message for server in JSON
-        """
-        self.uri = '/api/v1/locations/{0}'.format(LocationID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def delete(self, server, token, LocationID):
-        """Delete a location based on its location ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            LocationID {string} -- Location ID to be deleted
-        
-        Returns:
-            string -- response message for server in JSON
-        """
-        self.uri = '/api/v1/locations/{0}'.format(LocationID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Locations -
-
-

Class to access Location API

-
-Source code -
class Locations(object):
-    """Class to access Location API    
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None,order='asc', offset=None):
-        """Get list of locations.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of locations from the server, in JSON formatted
-        """
-        if limit is not None:
-            self.uri = '/api/v1/locations?limit={0}'.format(str(limit))
-            if offset is not None:
-                self.uri = self.uri + '&offset={0}'.format(str(offset))
-        else:
-            self.uri = '/api/v1/locations'
-            if offset is not None:
-                self.uri = self.uri + '?offset={0}'.format(str(offset))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def search(self, server, token, limit=None, order='asc', keyword=None):
-        """Get list of locations based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of locations in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/locations?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/locations?order={0}'.format(order)                  
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new location data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- Server response in JSON
-        """
-        self.uri = '/api/v1/locations'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, locationID):
-        """Get detailed location information by ID.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            locationID {string} -- Location ID to be searched
-        
-        Returns:
-            string -- Detailed information of a location
-        """
-        self.uri = '/api/v1/locations/{0}'.format(locationID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)        
-        return results.content
-
-    def updateLocation(self, server, token, LocationID, payload):
-        """Update location data information
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            LocationID {string} -- ID of the location to be updated
-            payload {string} -- input parameters
-        
-        Returns:
-            string -- response message for server in JSON
-        """
-        self.uri = '/api/v1/locations/{0}'.format(LocationID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def delete(self, server, token, LocationID):
-        """Delete a location based on its location ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            LocationID {string} -- Location ID to be deleted
-        
-        Returns:
-            string -- response message for server in JSON
-        """
-        self.uri = '/api/v1/locations/{0}'.format(LocationID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new location data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Input parameters

-

Returns

-
-
stringServer response in JSON
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new location data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- Server response in JSON
-    """
-    self.uri = '/api/v1/locations'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, LocationID) -
-
-

Delete a location based on its location ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -LocationID {string} – Location ID to be deleted

-

Returns

-
-
stringresponse message for server in JSON
-
 
-
-
-Source code -
def delete(self, server, token, LocationID):
-    """Delete a location based on its location ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        LocationID {string} -- Location ID to be deleted
-    
-    Returns:
-        string -- response message for server in JSON
-    """
-    self.uri = '/api/v1/locations/{0}'.format(LocationID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token, limit=None, order='asc', offset=None) -
-
-

Get list of locations.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-
-
stringList of locations from the server, in JSON formatted
-
 
-
-
-Source code -
def get(self, server, token, limit=None,order='asc', offset=None):
-    """Get list of locations.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of locations from the server, in JSON formatted
-    """
-    if limit is not None:
-        self.uri = '/api/v1/locations?limit={0}'.format(str(limit))
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-    else:
-        self.uri = '/api/v1/locations'
-        if offset is not None:
-            self.uri = self.uri + '?offset={0}'.format(str(offset))
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, locationID) -
-
-

Get detailed location information by ID.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -locationID {string} – Location ID to be searched

-

Returns

-
-
stringDetailed information of a location
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, locationID):
-    """Get detailed location information by ID.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        locationID {string} -- Location ID to be searched
-    
-    Returns:
-        string -- Detailed information of a location
-    """
-    self.uri = '/api/v1/locations/{0}'.format(locationID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)        
-    return results.content
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None) -
-
-

Get list of locations based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of locations in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None):
-    """Get list of locations based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of locations in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/locations?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/locations?order={0}'.format(order)                  
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def updateLocation(self, server, token, LocationID, payload) -
-
-

Update location data information

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -LocationID {string} – ID of the location to be updated -payload {string} – input parameters

-

Returns

-
-
stringresponse message for server in JSON
-
 
-
-
-Source code -
def updateLocation(self, server, token, LocationID, payload):
-    """Update location data information
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        LocationID {string} -- ID of the location to be updated
-        payload {string} -- input parameters
-    
-    Returns:
-        string -- response message for server in JSON
-    """
-    self.uri = '/api/v1/locations/{0}'.format(LocationID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Maintenances.html b/doc/snipeit/Maintenances.html deleted file mode 100644 index 66ed145..0000000 --- a/doc/snipeit/Maintenances.html +++ /dev/null @@ -1,480 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Maintenances

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Maintenances(object):
-    def __init__(self):
-        """Class to access maintenances API.
-        """
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of maintenances
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of maintenances in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/maintenances?limit={0}'.format(str(limit))
-            if offset is not None:
-                self.uri = self.uri + '&offset={0}'.format(str(offset))
-        else:
-            self.uri = '/api/v1/maintenances'
-            if offset is not None:
-                self.uri = self.uri + '?offset={0}'.format(str(offset))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of maintenances based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of maintenances in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit),order) 
-        else:
-            self.uri = '/api/v1/maintenances?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content        
-
-    def getMaintenanceByID(self, server, token, limit=None, order='asc', assetID=None, offset=None):
-        """Get maintenances information by asset ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-            assetID {string} -- Asset ID to be find
-
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of maintenances in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/maintenances?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri + '&asset_id={0}'.format(assetID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def create(self, server, token, payload):
-        """Create new maintenances data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/maintenances'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Maintenances -
-
-

Class to access maintenances API.

-
-Source code -
class Maintenances(object):
-    def __init__(self):
-        """Class to access maintenances API.
-        """
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of maintenances
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of maintenances in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/maintenances?limit={0}'.format(str(limit))
-            if offset is not None:
-                self.uri = self.uri + '&offset={0}'.format(str(offset))
-        else:
-            self.uri = '/api/v1/maintenances'
-            if offset is not None:
-                self.uri = self.uri + '?offset={0}'.format(str(offset))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of maintenances based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of maintenances in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit),order) 
-        else:
-            self.uri = '/api/v1/maintenances?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content        
-
-    def getMaintenanceByID(self, server, token, limit=None, order='asc', assetID=None, offset=None):
-        """Get maintenances information by asset ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-            assetID {string} -- Asset ID to be find
-
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of maintenances in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/maintenances?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri + '&asset_id={0}'.format(assetID)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def create(self, server, token, payload):
-        """Create new maintenances data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/maintenances'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new maintenances data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new maintenances data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/maintenances'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def get(self, server, token, limit=None, order='asc', offset=None) -
-
-

Get list of maintenances

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of maintenances in JSON format.

-
-Source code -
def get(self, server, token, limit=None, order='asc', offset=None):
-    """Get list of maintenances
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of maintenances in JSON format.
-    """
-    if limit is not None:
-        self.uri = '/api/v1/maintenances?limit={0}'.format(str(limit))
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-    else:
-        self.uri = '/api/v1/maintenances'
-        if offset is not None:
-            self.uri = self.uri + '?offset={0}'.format(str(offset))
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getMaintenanceByID(self, server, token, limit=None, order='asc', assetID=None, offset=None) -
-
-

Get maintenances information by asset ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -assetID {string} – Asset ID to be find -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of maintenances in JSON format.

-
-Source code -
def getMaintenanceByID(self, server, token, limit=None, order='asc', assetID=None, offset=None):
-    """Get maintenances information by asset ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-        assetID {string} -- Asset ID to be find
-
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of maintenances in JSON format.
-    """
-    if limit is not None:
-        self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/maintenances?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))
-    self.server = server + self.uri + '&asset_id={0}'.format(assetID)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None, offset=None) -
-
-

Get list of maintenances based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of maintenances in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-    """Get list of maintenances based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of maintenances in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/maintenances?limit={0}&order={1}'.format(str(limit),order) 
-    else:
-        self.uri = '/api/v1/maintenances?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content        
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Manufacturers.html b/doc/snipeit/Manufacturers.html deleted file mode 100644 index fa68b22..0000000 --- a/doc/snipeit/Manufacturers.html +++ /dev/null @@ -1,476 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Manufacturers

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Manufacturers(object):
-    def __init__(self):
-        """Class to access manufacturers API.
-        """
-        pass
-
-    def get(self, server, token):
-        """Get list of manufacturers
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of manufacturers in JSON format.
-        """       
-        self.uri = '/api/v1/manufacturers'  
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def create(self, server, token, payload):
-        """Create new manufacturers data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/manufacturers'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, manufacturersID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturersID {string} -- ID of the manufacturers
-        
-        Returns:
-            string -- Detailed information of manufacturers by ID
-        """
-        self.uri = '/api/v1/manufacturers/{0}'.format(manufacturersID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, manufacturersID):
-        """Delete manufacturers data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturersID {string} -- ID of the manufacturers
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/manufacturers/{0}'.format(manufacturersID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updatemanufacturers(self, server, token, manufacturersID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturersID {string} -- ID of the manufacturers
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/manufacturers/{0}'.format(manufacturersID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Manufacturers -
-
-

Class to access manufacturers API.

-
-Source code -
class Manufacturers(object):
-    def __init__(self):
-        """Class to access manufacturers API.
-        """
-        pass
-
-    def get(self, server, token):
-        """Get list of manufacturers
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of manufacturers in JSON format.
-        """       
-        self.uri = '/api/v1/manufacturers'  
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def create(self, server, token, payload):
-        """Create new manufacturers data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/manufacturers'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, manufacturersID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturersID {string} -- ID of the manufacturers
-        
-        Returns:
-            string -- Detailed information of manufacturers by ID
-        """
-        self.uri = '/api/v1/manufacturers/{0}'.format(manufacturersID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, manufacturersID):
-        """Delete manufacturers data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturersID {string} -- ID of the manufacturers
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/manufacturers/{0}'.format(manufacturersID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updatemanufacturers(self, server, token, manufacturersID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            manufacturersID {string} -- ID of the manufacturers
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/manufacturers/{0}'.format(manufacturersID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new manufacturers data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new manufacturers data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/manufacturers'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, manufacturersID) -
-
-

Delete manufacturers data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -manufacturersID {string} – ID of the manufacturers

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def delete(self, server, token, manufacturersID):
-    """Delete manufacturers data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        manufacturersID {string} -- ID of the manufacturers
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/manufacturers/{0}'.format(manufacturersID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token) -
-
-

Get list of manufacturers

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of manufacturers in JSON format.

-
-Source code -
def get(self, server, token):
-    """Get list of manufacturers
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of manufacturers in JSON format.
-    """       
-    self.uri = '/api/v1/manufacturers'  
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, manufacturersID) -
-
-

Get detailed information of label by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -manufacturersID {string} – ID of the manufacturers

-

Returns

-
-
stringDetailed information of manufacturers by ID
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, manufacturersID):
-    """Get detailed information of label by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        manufacturersID {string} -- ID of the manufacturers
-    
-    Returns:
-        string -- Detailed information of manufacturers by ID
-    """
-    self.uri = '/api/v1/manufacturers/{0}'.format(manufacturersID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)                
-    return results.content
-
-
-
-def updatemanufacturers(self, server, token, manufacturersID, payload) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -manufacturersID {string} – ID of the manufacturers -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def updatemanufacturers(self, server, token, manufacturersID, payload):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        manufacturersID {string} -- ID of the manufacturers
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/manufacturers/{0}'.format(manufacturersID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Models.html b/doc/snipeit/Models.html deleted file mode 100644 index e6438a4..0000000 --- a/doc/snipeit/Models.html +++ /dev/null @@ -1,596 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Models

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Models(object):
-    def __init__(self):
-        """Class to access models API.
-        """
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of models
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of models in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/models?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/models?order={0}'.format(order) 
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of models based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of models in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/models?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/models?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new model data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/models'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, modelsID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            modelsID {string} -- ID of the model
-        
-        Returns:
-            string -- Detailed information of modelsID by ID
-        """
-        self.uri = '/api/v1/models/{0}'.format(modelsID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, companyID):
-        """Delete model data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            ModelsID {string} -- ID of the model
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/models/{0}'.format(companyID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updateModel(self, server, token, companyID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            ModelsID {string} -- ID of the model
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/models/{0}'.format(companyID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Models -
-
-

Class to access models API.

-
-Source code -
class Models(object):
-    def __init__(self):
-        """Class to access models API.
-        """
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of models
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of models in JSON format.
-        """
-        if limit is not None:
-            self.uri = '/api/v1/models?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/models?order={0}'.format(order) 
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of models based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of models in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/models?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/models?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def create(self, server, token, payload):
-        """Create new model data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/models'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, modelsID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            modelsID {string} -- ID of the model
-        
-        Returns:
-            string -- Detailed information of modelsID by ID
-        """
-        self.uri = '/api/v1/models/{0}'.format(modelsID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    
-    def delete(self, server, token, companyID):
-        """Delete model data
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            ModelsID {string} -- ID of the model
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/models/{0}'.format(companyID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updateModel(self, server, token, companyID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            ModelsID {string} -- ID of the model
-            payload {string} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/models/{0}'.format(companyID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new model data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new model data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/models'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, companyID) -
-
-

Delete model data

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -ModelsID {string} – ID of the model

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def delete(self, server, token, companyID):
-    """Delete model data
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        ModelsID {string} -- ID of the model
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/models/{0}'.format(companyID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token, limit=None, order='asc', offset=None) -
-
-

Get list of models

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of models in JSON format.

-
-Source code -
def get(self, server, token, limit=None, order='asc', offset=None):
-    """Get list of models
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of models in JSON format.
-    """
-    if limit is not None:
-        self.uri = '/api/v1/models?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/models?order={0}'.format(order) 
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, modelsID) -
-
-

Get detailed information of label by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -modelsID {string} – ID of the model

-

Returns

-
-
stringDetailed information of modelsID by ID
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, modelsID):
-    """Get detailed information of label by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        modelsID {string} -- ID of the model
-    
-    Returns:
-        string -- Detailed information of modelsID by ID
-    """
-    self.uri = '/api/v1/models/{0}'.format(modelsID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)                
-    return results.content
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None, offset=None) -
-
-

Get list of models based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of models in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-    """Get list of models based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of models in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/models?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/models?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def updateModel(self, server, token, companyID, payload) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -ModelsID {string} – ID of the model -payload {string} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def updateModel(self, server, token, companyID, payload):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        ModelsID {string} -- ID of the model
-        payload {string} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/models/{0}'.format(companyID)
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/StatusLabels.html b/doc/snipeit/StatusLabels.html deleted file mode 100644 index f896ded..0000000 --- a/doc/snipeit/StatusLabels.html +++ /dev/null @@ -1,662 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.StatusLabels

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class StatusLabels(object):
-    """Class to access status labels API.    
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of status labels.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- list of status label in JSON format
-        """
-        if limit is not None:
-            self.uri = '/api/v1/statuslabels?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/statuslabels?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of statuslabels based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of statuslabels in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/statuslabels?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/statuslabels?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        
-    def create(self, server, token, payload):
-        """Create new status label
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/statuslabels'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, labelID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            labelID {string} -- ID of the label
-        
-        Returns:
-            string -- Detailed information of label by ID
-        """
-        self.uri = '/api/v1/statuslabels/{0}'.format(labelID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    def getAssetListByID(self, server, token, labelID):
-        """Get asset list based on label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            labelID {string} -- ID of the label
-        
-        Returns:
-            string -- Detailed information of label by ID
-        """
-        self.uri = '/api/v1/statuslabels/{0}/assetlist'.format(labelID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    def delete(self, server, token, labelID):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            labelID {[type]} -- ID of the label
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/statuslabels/{0}'.format(labelID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updateStatusLabel(self, server, token, labelID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            labelID {[type]} -- ID of the label
-            payload {[type]} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/statuslabels/{0}'.format(labelID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class StatusLabels -
-
-

Class to access status labels API.

-
-Source code -
class StatusLabels(object):
-    """Class to access status labels API.    
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of status labels.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- list of status label in JSON format
-        """
-        if limit is not None:
-            self.uri = '/api/v1/statuslabels?limit={0}&order={1}'.format(str(limit),order)
-        else:
-            self.uri = '/api/v1/statuslabels?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        #return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of statuslabels based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of statuslabels in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/statuslabels?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/statuslabels?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        
-    def create(self, server, token, payload):
-        """Create new status label
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/statuslabels'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getDetailsByID(self, server, token, labelID):
-        """Get detailed information of label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            labelID {string} -- ID of the label
-        
-        Returns:
-            string -- Detailed information of label by ID
-        """
-        self.uri = '/api/v1/statuslabels/{0}'.format(labelID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    def getAssetListByID(self, server, token, labelID):
-        """Get asset list based on label by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            labelID {string} -- ID of the label
-        
-        Returns:
-            string -- Detailed information of label by ID
-        """
-        self.uri = '/api/v1/statuslabels/{0}/assetlist'.format(labelID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    def delete(self, server, token, labelID):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            labelID {[type]} -- ID of the label
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/statuslabels/{0}'.format(labelID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def updateStatusLabel(self, server, token, labelID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            labelID {[type]} -- ID of the label
-            payload {[type]} -- Input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/statuslabels/{0}'.format(labelID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new status label

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new status label
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/statuslabels'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, labelID) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -labelID {[type]} – ID of the label

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def delete(self, server, token, labelID):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        labelID {[type]} -- ID of the label
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/statuslabels/{0}'.format(labelID)
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token, limit=None, order='asc', offset=None) -
-
-

Get list of status labels.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-
-
stringlist of status label in JSON format
-
 
-
-
-Source code -
def get(self, server, token, limit=None, order='asc', offset=None):
-    """Get list of status labels.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- list of status label in JSON format
-    """
-    if limit is not None:
-        self.uri = '/api/v1/statuslabels?limit={0}&order={1}'.format(str(limit),order)
-    else:
-        self.uri = '/api/v1/statuslabels?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getAssetListByID(self, server, token, labelID) -
-
-

Get asset list based on label by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -labelID {string} – ID of the label

-

Returns

-
-
stringDetailed information of label by ID
-
 
-
-
-Source code -
def getAssetListByID(self, server, token, labelID):
-    """Get asset list based on label by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        labelID {string} -- ID of the label
-    
-    Returns:
-        string -- Detailed information of label by ID
-    """
-    self.uri = '/api/v1/statuslabels/{0}/assetlist'.format(labelID)
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)                
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, labelID) -
-
-

Get detailed information of label by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -labelID {string} – ID of the label

-

Returns

-
-
stringDetailed information of label by ID
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, labelID):
-    """Get detailed information of label by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        labelID {string} -- ID of the label
-    
-    Returns:
-        string -- Detailed information of label by ID
-    """
-    self.uri = '/api/v1/statuslabels/{0}'.format(labelID)
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)                
-    return results.content
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None, offset=None) -
-
-

Get list of statuslabels based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of statuslabels in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-    """Get list of statuslabels based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of statuslabels in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/statuslabels?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/statuslabels?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def updateStatusLabel(self, server, token, labelID, payload) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -labelID {[type]} – ID of the label -payload {[type]} – Input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def updateStatusLabel(self, server, token, labelID, payload):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        labelID {[type]} -- ID of the label
-        payload {[type]} -- Input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/statuslabels/{0}'.format(labelID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/Users.html b/doc/snipeit/Users.html deleted file mode 100644 index bbd71f3..0000000 --- a/doc/snipeit/Users.html +++ /dev/null @@ -1,800 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit.Users

-
-
-
-Source code -
import ssl
-try:
-    _create_unverified_https_context = ssl._create_unverified_context
-except AttributeError:
-    # Legacy Python that doesn't verify HTTPS certificates by default
-    pass
-else:
-    # Handle target environment that doesn't support HTTPS verification
-    ssl._create_default_https_context = _create_unverified_https_context
-import requests
-try:
-    requests.packages.urllib3.disable_warnings()
-except AttributeError:
-    pass
-else:
-    requests.packages.urllib3.disable_warnings()
-try:
-    from .packages.urllib3.exceptions import ResponseError
-except:
-    pass
-
-import json
-
-class Users(object):
-    """Class to access users API.
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of user data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- list of user data in JSON format
-        """
-        if limit is not None:
-            self.uri = '/api/v1/users?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/users?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of users based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of users in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/users?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/users?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        
-    def create(self, server, token, payload):
-        """Create new user data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/users'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getID(self, server, token, user_name):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            user_name {[type]} -- [description]
-        
-        Returns:
-            [type] -- [description]
-        """
-        self.uri = '/api/v1/users?search={0}'.format(user_name)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        if len(jsonData['rows']) < 2 and jsonData['rows'][0]['id'] is not None:
-            UserID = jsonData['rows'][0]['id']
-        return UserID
-
-    def updateUser(self, server, token, UserID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            UserID {[type]} -- [description]
-            payload {[type]} -- [description]
-        
-        Returns:
-            [type] -- [description]
-        """
-        self.uri = '/api/v1/users/{0}'.format(UserID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def delete(self, server, token, UserID):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            UserID {[type]} -- [description]
-        
-        Returns:
-            [type] -- [description]
-        """
-        self.uri = '/api/v1/users/{0}'.format(UserID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def getDetailsByID(self, server, token, userID):
-        """Get detailed information of user by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            userID {string} -- ID of the user
-        
-        Returns:
-            string -- Detailed information of user by ID
-        """
-        self.uri = '/api/v1/users/{0}'.format(userID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    def getCheckedOutAssets(self, server, token, UserID):
-        """Get list of assets checked out to the user
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            componentsID {string} -- ID of the user
-        
-        Returns:
-            string -- list of assets in JSON format
-        """
-        self.uri = '/api/v1/users/{0}/assets'.format(UserID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-    
-
-    def getCheckedOutAccessories(self, server, token, UserID):
-        """Get list of accessories checked out to the user
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            componentsID {string} -- ID of the user
-        
-        Returns:
-            string -- list of accessories in JSON format
-        """
-        self.uri = '/api/v1/users/{0}/accessories'.format(UserID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-
-
-
-
-
-
-
-
-

Classes

-
-
-class Users -
-
-

Class to access users API.

-
-Source code -
class Users(object):
-    """Class to access users API.
-    """
-    def __init__(self):
-        pass
-
-    def get(self, server, token, limit=None, order='asc', offset=None):
-        """Get list of user data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            order {string} -- Display order of data (asc / desc default:{asc})
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- list of user data in JSON format
-        """
-        if limit is not None:
-            self.uri = '/api/v1/users?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/users?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-    def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-        """Get list of users based on search keyword
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-        
-        Keyword Arguments:
-            limit {string} -- Limit the number of data returned by the server (default: {50})
-        
-        Returns:
-            string -- List of users in JSON format.
-        """
-        if keyword is None:
-            keyword = ""
-        
-        if limit is not None:
-            self.uri = '/api/v1/users?limit={0}&order={1}'.format(str(limit), order)
-        else:
-            self.uri = '/api/v1/users?order={0}'.format(order)
-        if offset is not None:
-            self.uri = self.uri + '&offset={0}'.format(str(offset))            
-        self.server = server + self.uri  + '&search={0}'.format(keyword)
-        headers = {'Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-        
-    def create(self, server, token, payload):
-        """Create new user data.
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            payload {string} -- input parameters
-        
-        Returns:
-            string -- server response in JSON format
-        """
-        self.uri = '/api/v1/users'
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.post(self.server, headers=headers, data=payload)
-        return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-    def getID(self, server, token, user_name):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            user_name {[type]} -- [description]
-        
-        Returns:
-            [type] -- [description]
-        """
-        self.uri = '/api/v1/users?search={0}'.format(user_name)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        if len(jsonData['rows']) < 2 and jsonData['rows'][0]['id'] is not None:
-            UserID = jsonData['rows'][0]['id']
-        return UserID
-
-    def updateUser(self, server, token, UserID, payload):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            UserID {[type]} -- [description]
-            payload {[type]} -- [description]
-        
-        Returns:
-            [type] -- [description]
-        """
-        self.uri = '/api/v1/users/{0}'.format(UserID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.patch(self.server, headers=headers, data=payload)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def delete(self, server, token, UserID):
-        """[summary]
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            UserID {[type]} -- [description]
-        
-        Returns:
-            [type] -- [description]
-        """
-        self.uri = '/api/v1/users/{0}'.format(UserID)
-        self.server = server + self.uri 
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.delete(self.server, headers=headers)
-        jsonData = json.loads(results.content)
-        return jsonData['status']
-
-    def getDetailsByID(self, server, token, userID):
-        """Get detailed information of user by ID
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            userID {string} -- ID of the user
-        
-        Returns:
-            string -- Detailed information of user by ID
-        """
-        self.uri = '/api/v1/users/{0}'.format(userID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)                
-        return results.content
-
-    def getCheckedOutAssets(self, server, token, UserID):
-        """Get list of assets checked out to the user
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            componentsID {string} -- ID of the user
-        
-        Returns:
-            string -- list of assets in JSON format
-        """
-        self.uri = '/api/v1/users/{0}/assets'.format(UserID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-    
-
-    def getCheckedOutAccessories(self, server, token, UserID):
-        """Get list of accessories checked out to the user
-        
-        Arguments:
-            server {string} -- Server URI
-            token {string} -- Token value to be used for accessing the API
-            componentsID {string} -- ID of the user
-        
-        Returns:
-            string -- list of accessories in JSON format
-        """
-        self.uri = '/api/v1/users/{0}/accessories'.format(UserID)
-        self.server = server + self.uri
-        headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-        results = requests.get(self.server, headers=headers)
-        return results.content
-
-

Methods

-
-
-def create(self, server, token, payload) -
-
-

Create new user data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -payload {string} – input parameters

-

Returns

-
-
stringserver response in JSON format
-
 
-
-
-Source code -
def create(self, server, token, payload):
-    """Create new user data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        payload {string} -- input parameters
-    
-    Returns:
-        string -- server response in JSON format
-    """
-    self.uri = '/api/v1/users'
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.post(self.server, headers=headers, data=payload)
-    return json.dumps(results.json(),indent=4, separators=(',', ':'))
-
-
-
-def delete(self, server, token, UserID) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -UserID {[type]} – [description]

-

Returns

-

[type] – [description]

-
-Source code -
def delete(self, server, token, UserID):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        UserID {[type]} -- [description]
-    
-    Returns:
-        [type] -- [description]
-    """
-    self.uri = '/api/v1/users/{0}'.format(UserID)
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.delete(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-def get(self, server, token, limit=None, order='asc', offset=None) -
-
-

Get list of user data.

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -order {string} – Display order of data (asc / desc default:{asc}) -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-
-
stringlist of user data in JSON format
-
 
-
-
-Source code -
def get(self, server, token, limit=None, order='asc', offset=None):
-    """Get list of user data.
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        order {string} -- Display order of data (asc / desc default:{asc})
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- list of user data in JSON format
-    """
-    if limit is not None:
-        self.uri = '/api/v1/users?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/users?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getCheckedOutAccessories(self, server, token, UserID) -
-
-

Get list of accessories checked out to the user

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -componentsID {string} – ID of the user

-

Returns

-
-
stringlist of accessories in JSON format
-
 
-
-
-Source code -
def getCheckedOutAccessories(self, server, token, UserID):
-    """Get list of accessories checked out to the user
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        componentsID {string} -- ID of the user
-    
-    Returns:
-        string -- list of accessories in JSON format
-    """
-    self.uri = '/api/v1/users/{0}/accessories'.format(UserID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getCheckedOutAssets(self, server, token, UserID) -
-
-

Get list of assets checked out to the user

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -componentsID {string} – ID of the user

-

Returns

-
-
stringlist of assets in JSON format
-
 
-
-
-Source code -
def getCheckedOutAssets(self, server, token, UserID):
-    """Get list of assets checked out to the user
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        componentsID {string} -- ID of the user
-    
-    Returns:
-        string -- list of assets in JSON format
-    """
-    self.uri = '/api/v1/users/{0}/assets'.format(UserID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def getDetailsByID(self, server, token, userID) -
-
-

Get detailed information of user by ID

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -userID {string} – ID of the user

-

Returns

-
-
stringDetailed information of user by ID
-
 
-
-
-Source code -
def getDetailsByID(self, server, token, userID):
-    """Get detailed information of user by ID
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        userID {string} -- ID of the user
-    
-    Returns:
-        string -- Detailed information of user by ID
-    """
-    self.uri = '/api/v1/users/{0}'.format(userID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)                
-    return results.content
-
-
-
-def getID(self, server, token, user_name) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -user_name {[type]} – [description]

-

Returns

-

[type] – [description]

-
-Source code -
def getID(self, server, token, user_name):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        user_name {[type]} -- [description]
-    
-    Returns:
-        [type] -- [description]
-    """
-    self.uri = '/api/v1/users?search={0}'.format(user_name)
-    self.server = server + self.uri 
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    jsonData = json.loads(results.content)
-    if len(jsonData['rows']) < 2 and jsonData['rows'][0]['id'] is not None:
-        UserID = jsonData['rows'][0]['id']
-    return UserID
-
-
-
-def search(self, server, token, limit=None, order='asc', keyword=None, offset=None) -
-
-

Get list of users based on search keyword

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -Keyword Arguments: -limit {string} – Limit the number of data returned by the server (default: {50})

-

Returns

-

string – List of users in JSON format.

-
-Source code -
def search(self, server, token, limit=None, order='asc', keyword=None, offset=None):
-    """Get list of users based on search keyword
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-    
-    Keyword Arguments:
-        limit {string} -- Limit the number of data returned by the server (default: {50})
-    
-    Returns:
-        string -- List of users in JSON format.
-    """
-    if keyword is None:
-        keyword = ""
-    
-    if limit is not None:
-        self.uri = '/api/v1/users?limit={0}&order={1}'.format(str(limit), order)
-    else:
-        self.uri = '/api/v1/users?order={0}'.format(order)
-    if offset is not None:
-        self.uri = self.uri + '&offset={0}'.format(str(offset))            
-    self.server = server + self.uri  + '&search={0}'.format(keyword)
-    headers = {'Authorization': 'Bearer {0}'.format(token)}
-    results = requests.get(self.server, headers=headers)
-    return results.content
-
-
-
-def updateUser(self, server, token, UserID, payload) -
-
-

[summary]

-

Arguments

-

server {string} – Server URI -token {string} – Token value to be used for accessing the API -UserID {[type]} – [description] -payload {[type]} – [description]

-

Returns

-

[type] – [description]

-
-Source code -
def updateUser(self, server, token, UserID, payload):
-    """[summary]
-    
-    Arguments:
-        server {string} -- Server URI
-        token {string} -- Token value to be used for accessing the API
-        UserID {[type]} -- [description]
-        payload {[type]} -- [description]
-    
-    Returns:
-        [type] -- [description]
-    """
-    self.uri = '/api/v1/users/{0}'.format(UserID)
-    self.server = server + self.uri
-    headers = {'Content-Type': 'application/json','Authorization': 'Bearer {0}'.format(token)}
-    results = requests.patch(self.server, headers=headers, data=payload)
-    jsonData = json.loads(results.content)
-    return jsonData['status']
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/doc/snipeit/index.html b/doc/snipeit/index.html deleted file mode 100644 index ac2126a..0000000 --- a/doc/snipeit/index.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - -Codestin Search App - - - - - - - - - -
-
-
-

Module snipeit

-
-
-
-Source code -
from .Assets import Assets
-from .Company import Company
-from .Locations import Locations
-from .Accessories import Accessories
-from .Consumables import Consumables
-from .Components import Components
-from .Users import Users
-from .StatusLabels import StatusLabels
-from .Models import Models
-from .Categories import Categories
-from .Manufacturers import Manufacturers
-from .Fieldsets import Fieldsets
-from .Maintenances import Maintenances
-from .Licenses import Licenses
-
-
-
-

Sub-modules

-
-
snipeit.Accessories
-
-
-
-
snipeit.Assets
-
-
-
-
snipeit.AssetsMaintenances
-
-
-
-
snipeit.Categories
-
-
-
-
snipeit.Company
-
-
-
-
snipeit.Components
-
-
-
-
snipeit.Consumables
-
-
-
-
snipeit.DataUtil
-
-
-
-
snipeit.Fieldsets
-
-
-
-
snipeit.Licenses
-
-
-
-
snipeit.Locations
-
-
-
-
snipeit.Maintenances
-
-
-
-
snipeit.Manufacturers
-
-
-
-
snipeit.Models
-
-
-
-
snipeit.StatusLabels
-
-
-
-
snipeit.Users
-
-
-
-
-
-
-
-
-
-
-
-
- -
- - - - - \ No newline at end of file diff --git a/examples.py b/examples.py new file mode 100644 index 0000000..145479e --- /dev/null +++ b/examples.py @@ -0,0 +1,8 @@ +from snipeitpythonapi import Assets + +server = 'http://snipeitserver.example.com' +token = 'mysnipeittoken' + +snipeit_assets = Assets() +payload = '{"asset_tag":"thisisunique17", "status_id":1, "model_id": 5}' +response = snipeit_assets.create(server, token, payload) \ No newline at end of file