@wastesentry/trak-client 0.1.0

package/docs/RcraPhone.md

@@ -0,0 +1,35 @@
+
+# RcraPhone
+
+ManifestPhone model serializer for JSON marshalling/unmarshalling.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`number` | string
+`extension` | string
+
+## Example
+
+```typescript
+import type { RcraPhone } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "number": null,
+  "extension": null,
+} satisfies RcraPhone
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RcraPhone
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/RcraSite.md

@@ -0,0 +1,57 @@
+
+# RcraSite
+
+RcraSite model serializer for JSON marshalling/unmarshalling.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`epaSiteId` | string
+`siteType` | string
+`modified` | boolean
+`name` | string
+`siteAddress` | [RcraAddress](RcraAddress.md)
+`mailingAddress` | [RcraAddress](RcraAddress.md)
+`contact` | [RcraContact](RcraContact.md)
+`emergencyPhone` | [RcraPhone](RcraPhone.md)
+`registered` | boolean
+`limitedEsign` | boolean
+`canEsign` | boolean
+`hasRegisteredEmanifestUser` | boolean
+`gisPrimary` | boolean
+
+## Example
+
+```typescript
+import type { RcraSite } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "epaSiteId": null,
+  "siteType": null,
+  "modified": null,
+  "name": null,
+  "siteAddress": null,
+  "mailingAddress": null,
+  "contact": null,
+  "emergencyPhone": null,
+  "registered": null,
+  "limitedEsign": null,
+  "canEsign": null,
+  "hasRegisteredEmanifestUser": null,
+  "gisPrimary": null,
+} satisfies RcraSite
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RcraSite
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/RcraSitePermission.md

@@ -0,0 +1,45 @@
+
+# RcraSitePermission
+
+RcrainfoSiteAccess model serializer.  We use this internally because it\'s easier to handle, Using consistent naming, we have a separate serializer for user permissions from RCRAInfo.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`epaSiteId` | string
+`siteManagement` | boolean
+`annualReport` | string
+`biennialReport` | string
+`eManifest` | string
+`wIETS` | string
+`myRCRAid` | string
+
+## Example
+
+```typescript
+import type { RcraSitePermission } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "epaSiteId": null,
+  "siteManagement": null,
+  "annualReport": null,
+  "biennialReport": null,
+  "eManifest": null,
+  "wIETS": null,
+  "myRCRAid": null,
+} satisfies RcraSitePermission
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RcraSitePermission
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/RcraSiteSiteTypeEnum.md

@@ -0,0 +1,31 @@
+
+# RcraSiteSiteTypeEnum
+
+* `Generator` - Generator * `Transporter` - Transporter * `Tsdf` - Tsdf * `Broker` - Broker
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { RcraSiteSiteTypeEnum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies RcraSiteSiteTypeEnum
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RcraSiteSiteTypeEnum
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/RcrainfoProfile.md

@@ -0,0 +1,45 @@
+
+# RcrainfoProfile
+
+Model serializer for marshalling/unmarshalling a user\'s RcrainfoProfile.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | string
+`rcraAPIID` | string
+`rcraAPIKey` | string
+`rcraUsername` | string
+`rcraSites` | [Array<RcraSitePermission>](RcraSitePermission.md)
+`phoneNumber` | string
+`apiUser` | boolean
+
+## Example
+
+```typescript
+import type { RcrainfoProfile } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "rcraAPIID": null,
+  "rcraAPIKey": null,
+  "rcraUsername": null,
+  "rcraSites": null,
+  "phoneNumber": null,
+  "apiUser": null,
+} satisfies RcrainfoProfile
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RcrainfoProfile
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/RoleEnum.md

@@ -0,0 +1,31 @@
+
+# RoleEnum
+
+* `admin` - Administrator * `member` - Member
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { RoleEnum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies RoleEnum
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RoleEnum
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/Signer.md

@@ -0,0 +1,49 @@
+
+# Signer
+
+Serializer for EPA Signer Object.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`firstName` | string
+`middleInitial` | string
+`lastName` | string
+`phone` | [RcraPhone](RcraPhone.md)
+`email` | string
+`contactType` | string
+`companyName` | string
+`signerRole` | string
+
+## Example
+
+```typescript
+import type { Signer } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "firstName": null,
+  "middleInitial": null,
+  "lastName": null,
+  "phone": null,
+  "email": null,
+  "contactType": null,
+  "companyName": null,
+  "signerRole": null,
+} satisfies Signer
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Signer
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/Site.md

@@ -0,0 +1,35 @@
+
+# Site
+
+Site model serializer for JSON marshalling/unmarshalling.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`handler` | [RcraSite](RcraSite.md)
+
+## Example
+
+```typescript
+import type { Site } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "handler": null,
+} satisfies Site
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Site
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SiteApi.md

@@ -0,0 +1,147 @@
+# SiteApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**siteRetrieve**](SiteApi.md#siteretrieve) | **GET** /api/v1/rcrasite/{epa_id} |  |
+| [**siteSearchList**](SiteApi.md#sitesearchlist) | **GET** /api/v1/rcrasite/search |  |
+
+
+
+## siteRetrieve
+
+> RcraSite siteRetrieve(epaId)
+
+
+
+Retrieve details on a rcra_site stored in the database
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SiteApi,
+} from '';
+import type { SiteRetrieveRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new SiteApi(config);
+
+  const body = {
+    // string
+    epaId: epaId_example,
+  } satisfies SiteRetrieveRequest;
+
+  try {
+    const data = await api.siteRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **epaId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**RcraSite**](RcraSite.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## siteSearchList
+
+> Array<RcraSite> siteSearchList()
+
+
+
+Search for hazardous waste sites.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SiteApi,
+} from '';
+import type { SiteSearchListRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new SiteApi(config);
+
+  try {
+    const data = await api.siteSearchList();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<RcraSite>**](RcraSite.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SiteManifestSyncRequest.md

@@ -0,0 +1,32 @@
+
+# SiteManifestSyncRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`siteId` | string
+
+## Example
+
+```typescript
+import type { SiteManifestSyncRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "siteId": null,
+} satisfies SiteManifestSyncRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteManifestSyncRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SiteManifestSyncResponse.md

@@ -0,0 +1,32 @@
+
+# SiteManifestSyncResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`task` | string
+
+## Example
+
+```typescript
+import type { SiteManifestSyncResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "task": null,
+} satisfies SiteManifestSyncResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SiteManifestSyncResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)

package/docs/SitesApi.md

@@ -0,0 +1,155 @@
+# SitesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**sitesList**](SitesApi.md#siteslist) | **GET** /api/v1/sites |  |
+| [**sitesRetrieve**](SitesApi.md#sitesretrieve) | **GET** /api/v1/sites/{epa_id} |  |
+
+
+
+## sitesList
+
+> PaginatedSiteList sitesList(page)
+
+
+
+View all sites that the user has access to.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SitesApi,
+} from '';
+import type { SitesListRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new SitesApi(config);
+
+  const body = {
+    // number | A page number within the paginated result set. (optional)
+    page: 56,
+  } satisfies SitesListRequest;
+
+  try {
+    const data = await api.sitesList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedSiteList**](PaginatedSiteList.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## sitesRetrieve
+
+> Site sitesRetrieve(epaId)
+
+
+
+View details of a Site.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SitesApi,
+} from '';
+import type { SitesRetrieveRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: ApiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new SitesApi(config);
+
+  const body = {
+    // string
+    epaId: epaId_example,
+  } satisfies SitesRetrieveRequest;
+
+  try {
+    const data = await api.sitesRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **epaId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Site**](Site.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)