@wastesentry/trak-client 0.1.0

package/docs/StatusC23Enum.md

@@ -0,0 +1,31 @@
+
+# StatusC23Enum
+
+* `NotAssigned` - Not Assigned * `Pending` - Pending * `Scheduled` - Scheduled * `InTransit` - In Transit * `ReadyForSignature` - Ready for Signature * `Signed` - Signed * `Corrected` - Corrected * `UnderCorrection` - Under Correction * `MtnValidationFailed` - MTN Validation Failed
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { StatusC23Enum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies StatusC23Enum
+
+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 StatusC23Enum
+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/Subscription.md

@@ -0,0 +1,51 @@
+
+# Subscription
+
+A serializer for Subscriptions which uses the SubscriptionWrapper object under the hood
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`displayName` | string
+`startDate` | Date
+`billingInterval` | string
+`currentPeriodStart` | Date
+`currentPeriodEnd` | Date
+`cancelAtPeriodEnd` | boolean
+`status` | [SubscriptionStatusEnum](SubscriptionStatusEnum.md)
+`quantity` | number
+`items` | [Array<SubscriptionItem>](SubscriptionItem.md)
+
+## Example
+
+```typescript
+import type { Subscription } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "displayName": null,
+  "startDate": null,
+  "billingInterval": null,
+  "currentPeriodStart": null,
+  "currentPeriodEnd": null,
+  "cancelAtPeriodEnd": null,
+  "status": null,
+  "quantity": null,
+  "items": null,
+} satisfies Subscription
+
+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 Subscription
+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/SubscriptionItem.md

@@ -0,0 +1,36 @@
+
+# SubscriptionItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`price` | [Price](Price.md)
+`quantity` | number
+
+## Example
+
+```typescript
+import type { SubscriptionItem } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "price": null,
+  "quantity": null,
+} satisfies SubscriptionItem
+
+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 SubscriptionItem
+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/SubscriptionStatusEnum.md

@@ -0,0 +1,31 @@
+
+# SubscriptionStatusEnum
+
+* `active` - Active * `canceled` - Canceled * `incomplete` - Incomplete * `incomplete_expired` - Incomplete Expired * `past_due` - Past due * `trialing` - Trialing * `unpaid` - Unpaid
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { SubscriptionStatusEnum } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies SubscriptionStatusEnum
+
+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 SubscriptionStatusEnum
+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/SyncApi.md

@@ -0,0 +1,73 @@
+# SyncApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**syncCreate**](SyncApi.md#synccreate) | **POST** /api/v1/sync |  |
+
+
+
+## syncCreate
+
+> syncCreate()
+
+
+
+Create a job to sync the user\'s RCRAInfo profile.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SyncApi,
+} from '';
+import type { SyncCreateRequest } 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 SyncApi(config);
+
+  try {
+    const data = await api.syncCreate();
+    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
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | No response body |  -  |
+
+[[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/Team.md

@@ -0,0 +1,48 @@
+
+# Team
+
+
+## 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 { Team } 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 Team
+
+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 Team
+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)