@wastesentry/trak-client 0.1.0

package/docs/ManifestPhone.md

@@ -0,0 +1,35 @@
+
+# ManifestPhone
+
+Serializer for phone numbers on manifest.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`number` | string
+`extension` | string
+
+## Example
+
+```typescript
+import type { ManifestPhone } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "number": null,
+  "extension": null,
+} satisfies ManifestPhone
+
+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 ManifestPhone
+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/Membership.md

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

@@ -0,0 +1,39 @@
+
+# Mtn
+
+Select details of a manifest including manifest tracking number (mtn).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`manifestTrackingNumber` | string
+`status` | [StatusC23Enum](StatusC23Enum.md)
+`submissionType` | string
+`signatureStatus` | boolean
+
+## Example
+
+```typescript
+import type { Mtn } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "manifestTrackingNumber": null,
+  "status": null,
+  "submissionType": null,
+  "signatureStatus": null,
+} satisfies Mtn
+
+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 Mtn
+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/MyProfileApi.md

@@ -0,0 +1,73 @@
+# MyProfileApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**myProfileRetrieve**](MyProfileApi.md#myprofileretrieve) | **GET** /api/v1/my-profile |  |
+
+
+
+## myProfileRetrieve
+
+> Profile myProfileRetrieve()
+
+
+
+Displays a user\'s Profile.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MyProfileApi,
+} from '';
+import type { MyProfileRetrieveRequest } 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 MyProfileApi(config);
+
+  try {
+    const data = await api.myProfileRetrieve();
+    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
+
+[**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)

package/docs/NullEnum.md

@@ -0,0 +1,30 @@
+
+# NullEnum
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { NullEnum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies NullEnum
+
+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 NullEnum
+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/OpenInvitation.md

@@ -0,0 +1,38 @@
+
+# OpenInvitation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`teamName` | string
+`email` | string
+`verified` | boolean
+
+## Example
+
+```typescript
+import type { OpenInvitation } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "teamName": null,
+  "email": null,
+  "verified": null,
+} satisfies OpenInvitation
+
+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 OpenInvitation
+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/Org.md

@@ -0,0 +1,39 @@
+
+# Org
+
+Organization Model Serializer.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`id` | string
+`slug` | string
+`rcrainfoIntegrated` | boolean
+
+## Example
+
+```typescript
+import type { Org } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "id": null,
+  "slug": null,
+  "rcrainfoIntegrated": null,
+} satisfies Org
+
+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 Org
+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/OrgsApi.md

@@ -0,0 +1,232 @@
+# OrgsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**orgsList**](OrgsApi.md#orgslist) | **GET** /api/v1/orgs |  |
+| [**orgsRetrieve**](OrgsApi.md#orgsretrieve) | **GET** /api/v1/orgs/{org_slug} |  |
+| [**orgsSitesList**](OrgsApi.md#orgssiteslist) | **GET** /api/v1/orgs/{org_slug}/sites |  |
+
+
+
+## orgsList
+
+> PaginatedOrgList orgsList(page)
+
+
+
+View all organizations that the user has access to.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OrgsApi,
+} from '';
+import type { OrgsListRequest } 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 OrgsApi(config);
+
+  const body = {
+    // number | A page number within the paginated result set. (optional)
+    page: 56,
+  } satisfies OrgsListRequest;
+
+  try {
+    const data = await api.orgsList(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
+
+[**PaginatedOrgList**](PaginatedOrgList.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)
+
+
+## orgsRetrieve
+
+> Org orgsRetrieve(orgSlug)
+
+
+
+Retrieve details for a given Org.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OrgsApi,
+} from '';
+import type { OrgsRetrieveRequest } 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 OrgsApi(config);
+
+  const body = {
+    // string
+    orgSlug: orgSlug_example,
+  } satisfies OrgsRetrieveRequest;
+
+  try {
+    const data = await api.orgsRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgSlug** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Org**](Org.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)
+
+
+## orgsSitesList
+
+> PaginatedSiteList orgsSitesList(orgSlug, page)
+
+
+
+View all sites that the user has access to.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OrgsApi,
+} from '';
+import type { OrgsSitesListRequest } 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 OrgsApi(config);
+
+  const body = {
+    // string
+    orgSlug: orgSlug_example,
+    // number | A page number within the paginated result set. (optional)
+    page: 56,
+  } satisfies OrgsSitesListRequest;
+
+  try {
+    const data = await api.orgsSitesList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgSlug** | `string` |  | [Defaults to `undefined`] |
+| **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)

package/docs/PaginatedInvitationList.md

@@ -0,0 +1,38 @@
+
+# PaginatedInvitationList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<Invitation>](Invitation.md)
+
+## Example
+
+```typescript
+import type { PaginatedInvitationList } 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 PaginatedInvitationList
+
+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 PaginatedInvitationList
+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/PaginatedMtnList.md

@@ -0,0 +1,38 @@
+
+# PaginatedMtnList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<Mtn>](Mtn.md)
+
+## Example
+
+```typescript
+import type { PaginatedMtnList } 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 PaginatedMtnList
+
+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 PaginatedMtnList
+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/PaginatedOrgList.md

@@ -0,0 +1,38 @@
+
+# PaginatedOrgList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<Org>](Org.md)
+
+## Example
+
+```typescript
+import type { PaginatedOrgList } 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 PaginatedOrgList
+
+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 PaginatedOrgList
+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/PaginatedSiteList.md

@@ -0,0 +1,38 @@
+
+# PaginatedSiteList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`next` | string
+`previous` | string
+`results` | [Array<Site>](Site.md)
+
+## Example
+
+```typescript
+import type { PaginatedSiteList } 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 PaginatedSiteList
+
+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 PaginatedSiteList
+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)