@wastesentry/trak-client 0.1.0

package/docs/PaginatedTeamList.md

@@ -0,0 +1,38 @@
+
+# PaginatedTeamList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<Team>](Team.md)
+
+## Example
+
+```typescript
+import type { PaginatedTeamList } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": 123,
+  "next": http://api.example.org/accounts/?page=4,
+  "previous": http://api.example.org/accounts/?page=2,
+  "results": null,
+} satisfies PaginatedTeamList
+
+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 PaginatedTeamList
+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/PaperSignature.md

@@ -0,0 +1,35 @@
+
+# PaperSignature
+
+Serializer for Paper Signature on manifest.  Indicates the change of custody with paper manifests.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`printedName` | string
+`signatureDate` | Date
+
+## Example
+
+```typescript
+import type { PaperSignature } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "printedName": null,
+  "signatureDate": null,
+} satisfies PaperSignature
+
+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 PaperSignature
+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/PatchedInvitation.md

@@ -0,0 +1,42 @@
+
+# PatchedInvitation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`team` | number
+`email` | string
+`role` | [RoleEnum](RoleEnum.md)
+`invitedBy` | string
+`isAccepted` | boolean
+
+## Example
+
+```typescript
+import type { PatchedInvitation } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "team": null,
+  "email": null,
+  "role": null,
+  "invitedBy": null,
+  "isAccepted": null,
+} satisfies PatchedInvitation
+
+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 PatchedInvitation
+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/PatchedProfile.md

@@ -0,0 +1,35 @@
+
+# PatchedProfile
+
+Serializer for a user\'s profile.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | [TrakUser](TrakUser.md)
+`avatar` | string
+
+## Example
+
+```typescript
+import type { PatchedProfile } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "avatar": null,
+} satisfies PatchedProfile
+
+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 PatchedProfile
+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/PatchedRcrainfoProfile.md

@@ -0,0 +1,45 @@
+
+# PatchedRcrainfoProfile
+
+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 { PatchedRcrainfoProfile } 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 PatchedRcrainfoProfile
+
+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 PatchedRcrainfoProfile
+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/PatchedTeam.md

@@ -0,0 +1,48 @@
+
+# PatchedTeam
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`slug` | string
+`members` | [Array<Membership>](Membership.md)
+`invitations` | [Array<Invitation>](Invitation.md)
+`dashboardUrl` | string
+`isAdmin` | boolean
+`subscription` | [Subscription](Subscription.md)
+`hasActiveSubscription` | boolean
+
+## Example
+
+```typescript
+import type { PatchedTeam } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "slug": null,
+  "members": null,
+  "invitations": null,
+  "dashboardUrl": null,
+  "isAdmin": null,
+  "subscription": null,
+  "hasActiveSubscription": null,
+} satisfies PatchedTeam
+
+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 PatchedTeam
+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/Price.md

@@ -0,0 +1,42 @@
+
+# Price
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`productName` | string
+`humanReadablePrice` | string
+`paymentAmount` | string
+`nickname` | string
+`unitAmount` | number
+
+## Example
+
+```typescript
+import type { Price } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "productName": null,
+  "humanReadablePrice": null,
+  "paymentAmount": null,
+  "nickname": null,
+  "unitAmount": null,
+} satisfies Price
+
+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 Price
+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/Profile.md

@@ -0,0 +1,35 @@
+
+# Profile
+
+Serializer for a user\'s profile.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | [TrakUser](TrakUser.md)
+`avatar` | string
+
+## Example
+
+```typescript
+import type { Profile } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "avatar": null,
+} satisfies Profile
+
+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 Profile
+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/ProfileApi.md

@@ -0,0 +1,241 @@
+# ProfileApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**profilePartialUpdate**](ProfileApi.md#profilepartialupdate) | **PATCH** /api/v1/profile/{user_id} |  |
+| [**profileRetrieve**](ProfileApi.md#profileretrieve) | **GET** /api/v1/profile/{user_id} |  |
+| [**profileUpdate**](ProfileApi.md#profileupdate) | **PUT** /api/v1/profile/{user_id} |  |
+
+
+
+## profilePartialUpdate
+
+> Profile profilePartialUpdate(userId, user, avatar)
+
+
+
+ViewSet for the Profile model.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProfileApi,
+} from '';
+import type { ProfilePartialUpdateRequest } 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 ProfileApi(config);
+
+  const body = {
+    // string | A UUID string identifying this profile.
+    userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // TrakUser (optional)
+    user: ...,
+    // string (optional)
+    avatar: avatar_example,
+  } satisfies ProfilePartialUpdateRequest;
+
+  try {
+    const data = await api.profilePartialUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` | A UUID string identifying this profile. | [Defaults to `undefined`] |
+| **user** | [TrakUser](TrakUser.md) |  | [Optional] [Defaults to `undefined`] |
+| **avatar** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Profile**](Profile.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`, `application/x-www-form-urlencoded`, `application/json`
+- **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)
+
+
+## profileRetrieve
+
+> Profile profileRetrieve(userId)
+
+
+
+ViewSet for the Profile model.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProfileApi,
+} from '';
+import type { ProfileRetrieveRequest } 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 ProfileApi(config);
+
+  const body = {
+    // string | A UUID string identifying this profile.
+    userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ProfileRetrieveRequest;
+
+  try {
+    const data = await api.profileRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` | A UUID string identifying this profile. | [Defaults to `undefined`] |
+
+### Return type
+
+[**Profile**](Profile.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)
+
+
+## profileUpdate
+
+> Profile profileUpdate(userId, user, avatar)
+
+
+
+ViewSet for the Profile model.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProfileApi,
+} from '';
+import type { ProfileUpdateRequest } 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 ProfileApi(config);
+
+  const body = {
+    // string | A UUID string identifying this profile.
+    userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // TrakUser
+    user: ...,
+    // string (optional)
+    avatar: avatar_example,
+  } satisfies ProfileUpdateRequest;
+
+  try {
+    const data = await api.profileUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` | A UUID string identifying this profile. | [Defaults to `undefined`] |
+| **user** | [TrakUser](TrakUser.md) |  | [Defaults to `undefined`] |
+| **avatar** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Profile**](Profile.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`, `application/x-www-form-urlencoded`, `application/json`
+- **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/QuickerSign.md

@@ -0,0 +1,43 @@
+
+# QuickerSign
+
+Serializer for EPA Quicker Sign objects.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`manifestTrackingNumbers` | Array<string>
+`printedSignatureName` | string
+`printedSignatureDate` | Date
+`siteType` | string
+`siteId` | string
+`transporterOrder` | number
+
+## Example
+
+```typescript
+import type { QuickerSign } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "manifestTrackingNumbers": null,
+  "printedSignatureName": null,
+  "printedSignatureDate": null,
+  "siteType": null,
+  "siteId": null,
+  "transporterOrder": null,
+} satisfies QuickerSign
+
+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 QuickerSign
+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/RcraAddress.md

@@ -0,0 +1,45 @@
+
+# RcraAddress
+
+Address model serializer for JSON representation.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`streetNumber` | string
+`address1` | string
+`address2` | string
+`city` | string
+`state` | { [key: string]: any; }
+`country` | { [key: string]: any; }
+`zip` | string
+
+## Example
+
+```typescript
+import type { RcraAddress } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "streetNumber": null,
+  "address1": null,
+  "address2": null,
+  "city": null,
+  "state": null,
+  "country": null,
+  "zip": null,
+} satisfies RcraAddress
+
+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 RcraAddress
+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/RcraContact.md

@@ -0,0 +1,43 @@
+
+# RcraContact
+
+Contact serializer for JSON marshaling/unmarshalling.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`middleInitial` | string
+`lastName` | string
+`phone` | [RcraPhone](RcraPhone.md)
+`email` | string
+`companyName` | string
+
+## Example
+
+```typescript
+import type { RcraContact } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "middleInitial": null,
+  "lastName": null,
+  "phone": null,
+  "email": null,
+  "companyName": null,
+} satisfies RcraContact
+
+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 RcraContact
+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)