@wastesentry/trak-client 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +55 -118
- package/.openapi-generator/VERSION +1 -1
- package/README.md +140 -0
- package/api.ts +26 -0
- package/apis/default-api.ts +328 -0
- package/apis/info-api.ts +149 -0
- package/apis/manifest-api.ts +1135 -0
- package/apis/my-profile-api.ts +131 -0
- package/apis/orgs-api.ts +333 -0
- package/apis/profile-api.ts +383 -0
- package/apis/site-api.ts +215 -0
- package/apis/sites-api.ts +236 -0
- package/apis/sync-api.ts +128 -0
- package/base.ts +62 -0
- package/common.ts +127 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +20 -0
- package/dist/api.js +38 -0
- package/dist/apis/default-api.d.ts +170 -0
- package/dist/apis/default-api.js +266 -0
- package/dist/apis/info-api.d.ts +82 -0
- package/dist/apis/info-api.js +129 -0
- package/dist/apis/manifest-api.d.ts +566 -0
- package/dist/apis/manifest-api.js +868 -0
- package/dist/apis/my-profile-api.d.ts +70 -0
- package/dist/apis/my-profile-api.js +121 -0
- package/dist/apis/orgs-api.d.ts +174 -0
- package/dist/apis/orgs-api.js +263 -0
- package/dist/apis/profile-api.d.ts +191 -0
- package/dist/apis/profile-api.js +298 -0
- package/dist/apis/site-api.d.ts +111 -0
- package/dist/apis/site-api.js +186 -0
- package/dist/apis/sites-api.d.ts +126 -0
- package/dist/apis/sites-api.js +193 -0
- package/dist/apis/sync-api.d.ts +69 -0
- package/dist/apis/sync-api.js +120 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +34 -0
- package/dist/common.js +139 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +20 -0
- package/dist/esm/api.js +22 -0
- package/dist/esm/apis/default-api.d.ts +170 -0
- package/dist/esm/apis/default-api.js +259 -0
- package/dist/esm/apis/info-api.d.ts +82 -0
- package/dist/esm/apis/info-api.js +122 -0
- package/dist/esm/apis/manifest-api.d.ts +566 -0
- package/dist/esm/apis/manifest-api.js +861 -0
- package/dist/esm/apis/my-profile-api.d.ts +70 -0
- package/dist/esm/apis/my-profile-api.js +114 -0
- package/dist/esm/apis/orgs-api.d.ts +174 -0
- package/dist/esm/apis/orgs-api.js +256 -0
- package/dist/esm/apis/profile-api.d.ts +191 -0
- package/dist/esm/apis/profile-api.js +291 -0
- package/dist/esm/apis/site-api.d.ts +111 -0
- package/dist/esm/apis/site-api.js +179 -0
- package/dist/esm/apis/sites-api.d.ts +126 -0
- package/dist/esm/apis/sites-api.js +186 -0
- package/dist/esm/apis/sync-api.d.ts +69 -0
- package/dist/esm/apis/sync-api.js +113 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +34 -0
- package/dist/esm/common.js +126 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +14 -0
- package/dist/esm/index.js +16 -0
- package/dist/esm/models/additional-info.d.ts +21 -0
- package/dist/esm/models/additional-info.js +14 -0
- package/dist/esm/models/esignature.d.ts +23 -0
- package/dist/esm/models/esignature.js +14 -0
- package/dist/esm/models/handler-search-site-type-enum.d.ts +21 -0
- package/dist/esm/models/handler-search-site-type-enum.js +22 -0
- package/dist/esm/models/handler-search.d.ts +16 -0
- package/dist/esm/models/handler-search.js +14 -0
- package/dist/esm/models/handler.d.ts +28 -0
- package/dist/esm/models/handler.js +14 -0
- package/dist/esm/models/index.d.ts +34 -0
- package/dist/esm/models/index.js +34 -0
- package/dist/esm/models/lock-reason-enum.d.ts +20 -0
- package/dist/esm/models/lock-reason-enum.js +21 -0
- package/dist/esm/models/manifest-phone.d.ts +18 -0
- package/dist/esm/models/manifest-phone.js +14 -0
- package/dist/esm/models/manifest.d.ts +53 -0
- package/dist/esm/models/manifest.js +14 -0
- package/dist/esm/models/mtn.d.ts +21 -0
- package/dist/esm/models/mtn.js +14 -0
- package/dist/esm/models/null-enum.d.ts +13 -0
- package/dist/esm/models/null-enum.js +14 -0
- package/dist/esm/models/org.d.ts +20 -0
- package/dist/esm/models/org.js +14 -0
- package/dist/esm/models/paginated-mtn-list.d.ts +18 -0
- package/dist/esm/models/paginated-mtn-list.js +14 -0
- package/dist/esm/models/paginated-org-list.d.ts +18 -0
- package/dist/esm/models/paginated-org-list.js +14 -0
- package/dist/esm/models/paginated-site-list.d.ts +18 -0
- package/dist/esm/models/paginated-site-list.js +14 -0
- package/dist/esm/models/paper-signature.d.ts +18 -0
- package/dist/esm/models/paper-signature.js +14 -0
- package/dist/esm/models/patched-profile.d.ts +20 -0
- package/dist/esm/models/patched-profile.js +14 -0
- package/dist/esm/models/patched-rcrainfo-profile.d.ts +24 -0
- package/dist/esm/models/patched-rcrainfo-profile.js +14 -0
- package/dist/esm/models/profile.d.ts +20 -0
- package/dist/esm/models/profile.js +14 -0
- package/dist/esm/models/quicker-sign.d.ts +22 -0
- package/dist/esm/models/quicker-sign.js +14 -0
- package/dist/esm/models/rcra-address.d.ts +27 -0
- package/dist/esm/models/rcra-address.js +14 -0
- package/dist/esm/models/rcra-contact.d.ts +23 -0
- package/dist/esm/models/rcra-contact.js +14 -0
- package/dist/esm/models/rcra-phone.d.ts +18 -0
- package/dist/esm/models/rcra-phone.js +14 -0
- package/dist/esm/models/rcra-site-permission.d.ts +23 -0
- package/dist/esm/models/rcra-site-permission.js +14 -0
- package/dist/esm/models/rcra-site.d.ts +39 -0
- package/dist/esm/models/rcra-site.js +19 -0
- package/dist/esm/models/rcrainfo-profile.d.ts +24 -0
- package/dist/esm/models/rcrainfo-profile.js +14 -0
- package/dist/esm/models/signer.d.ts +26 -0
- package/dist/esm/models/signer.js +14 -0
- package/dist/esm/models/site-manifest-sync-request.d.ts +14 -0
- package/dist/esm/models/site-manifest-sync-request.js +14 -0
- package/dist/esm/models/site-manifest-sync-response.d.ts +14 -0
- package/dist/esm/models/site-manifest-sync-response.js +14 -0
- package/dist/esm/models/site-type-enum.d.ts +21 -0
- package/dist/esm/models/site-type-enum.js +22 -0
- package/dist/esm/models/site.d.ts +19 -0
- package/dist/esm/models/site.js +14 -0
- package/dist/esm/models/status-enum.d.ts +26 -0
- package/dist/esm/models/status-enum.js +27 -0
- package/dist/esm/models/trak-user.d.ts +20 -0
- package/dist/esm/models/trak-user.js +14 -0
- package/dist/esm/models/transporter.d.ts +27 -0
- package/dist/esm/models/transporter.js +14 -0
- package/dist/esm/models/waste-line.d.ts +28 -0
- package/dist/esm/models/waste-line.js +14 -0
- package/dist/index.d.ts +14 -0
- package/dist/index.js +32 -0
- package/dist/models/additional-info.d.ts +21 -0
- package/dist/models/additional-info.js +15 -0
- package/dist/models/esignature.d.ts +23 -0
- package/dist/models/esignature.js +15 -0
- package/dist/models/handler-search-site-type-enum.d.ts +21 -0
- package/dist/models/handler-search-site-type-enum.js +25 -0
- package/dist/models/handler-search.d.ts +16 -0
- package/dist/models/handler-search.js +15 -0
- package/dist/models/handler.d.ts +28 -0
- package/dist/models/handler.js +15 -0
- package/dist/models/index.d.ts +34 -0
- package/dist/models/index.js +50 -0
- package/dist/models/lock-reason-enum.d.ts +20 -0
- package/dist/models/lock-reason-enum.js +24 -0
- package/dist/models/manifest-phone.d.ts +18 -0
- package/dist/models/manifest-phone.js +15 -0
- package/dist/models/manifest.d.ts +53 -0
- package/dist/models/manifest.js +15 -0
- package/dist/models/mtn.d.ts +21 -0
- package/dist/models/mtn.js +15 -0
- package/dist/models/null-enum.d.ts +13 -0
- package/dist/models/null-enum.js +17 -0
- package/dist/models/org.d.ts +20 -0
- package/dist/models/org.js +15 -0
- package/dist/models/paginated-mtn-list.d.ts +18 -0
- package/dist/models/paginated-mtn-list.js +15 -0
- package/dist/models/paginated-org-list.d.ts +18 -0
- package/dist/models/paginated-org-list.js +15 -0
- package/dist/models/paginated-site-list.d.ts +18 -0
- package/dist/models/paginated-site-list.js +15 -0
- package/dist/models/paper-signature.d.ts +18 -0
- package/dist/models/paper-signature.js +15 -0
- package/dist/models/patched-profile.d.ts +20 -0
- package/dist/models/patched-profile.js +15 -0
- package/dist/models/patched-rcrainfo-profile.d.ts +24 -0
- package/dist/models/patched-rcrainfo-profile.js +15 -0
- package/dist/models/profile.d.ts +20 -0
- package/dist/models/profile.js +15 -0
- package/dist/models/quicker-sign.d.ts +22 -0
- package/dist/models/quicker-sign.js +15 -0
- package/dist/models/rcra-address.d.ts +27 -0
- package/dist/models/rcra-address.js +15 -0
- package/dist/models/rcra-contact.d.ts +23 -0
- package/dist/models/rcra-contact.js +15 -0
- package/dist/models/rcra-phone.d.ts +18 -0
- package/dist/models/rcra-phone.js +15 -0
- package/dist/models/rcra-site-permission.d.ts +23 -0
- package/dist/models/rcra-site-permission.js +15 -0
- package/dist/models/rcra-site.d.ts +39 -0
- package/dist/models/rcra-site.js +22 -0
- package/dist/models/rcrainfo-profile.d.ts +24 -0
- package/dist/models/rcrainfo-profile.js +15 -0
- package/dist/models/signer.d.ts +26 -0
- package/dist/models/signer.js +15 -0
- package/dist/models/site-manifest-sync-request.d.ts +14 -0
- package/dist/models/site-manifest-sync-request.js +15 -0
- package/dist/models/site-manifest-sync-response.d.ts +14 -0
- package/dist/models/site-manifest-sync-response.js +15 -0
- package/dist/models/site-type-enum.d.ts +21 -0
- package/dist/models/site-type-enum.js +25 -0
- package/dist/models/site.d.ts +19 -0
- package/dist/models/site.js +15 -0
- package/dist/models/status-enum.d.ts +26 -0
- package/dist/models/status-enum.js +30 -0
- package/dist/models/trak-user.d.ts +20 -0
- package/dist/models/trak-user.js +15 -0
- package/dist/models/transporter.d.ts +27 -0
- package/dist/models/transporter.js +15 -0
- package/dist/models/waste-line.d.ts +28 -0
- package/dist/models/waste-line.js +15 -0
- package/git_push.sh +57 -0
- package/index.ts +16 -3
- package/models/additional-info.ts +27 -0
- package/models/esignature.ts +31 -0
- package/models/handler-search-site-type-enum.ts +31 -0
- package/models/handler-search.ts +26 -0
- package/models/handler.ts +42 -0
- package/models/index.ts +34 -50
- package/models/lock-reason-enum.ts +30 -0
- package/models/manifest-phone.ts +24 -0
- package/models/manifest.ts +73 -0
- package/models/mtn.ts +31 -0
- package/models/null-enum.ts +24 -0
- package/models/org.ts +26 -0
- package/models/paginated-mtn-list.ts +26 -0
- package/models/paginated-org-list.ts +26 -0
- package/models/paginated-site-list.ts +26 -0
- package/models/paper-signature.ts +24 -0
- package/models/patched-profile.ts +28 -0
- package/models/patched-rcrainfo-profile.ts +32 -0
- package/models/profile.ts +28 -0
- package/models/quicker-sign.ts +28 -0
- package/models/rcra-address.ts +29 -0
- package/models/rcra-contact.ts +31 -0
- package/models/rcra-phone.ts +24 -0
- package/models/rcra-site-permission.ts +29 -0
- package/models/rcra-site.ts +54 -0
- package/models/rcrainfo-profile.ts +32 -0
- package/models/signer.ts +34 -0
- package/models/site-manifest-sync-request.ts +20 -0
- package/models/site-manifest-sync-response.ts +20 -0
- package/models/site-type-enum.ts +31 -0
- package/models/site.ts +27 -0
- package/models/status-enum.ts +36 -0
- package/models/trak-user.ts +26 -0
- package/models/transporter.ts +39 -0
- package/models/waste-line.ts +34 -0
- package/package.json +26 -10
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
- package/apis/DefaultApi.ts +0 -176
- package/apis/InfoApi.ts +0 -80
- package/apis/ManifestApi.ts +0 -604
- package/apis/MyProfileApi.ts +0 -63
- package/apis/OrgsApi.ts +0 -172
- package/apis/PegasusApi.ts +0 -336
- package/apis/ProfileApi.ts +0 -229
- package/apis/SiteApi.ts +0 -108
- package/apis/SitesApi.ts +0 -119
- package/apis/SyncApi.ts +0 -55
- package/apis/TeamsApi.ts +0 -673
- package/apis/index.ts +0 -12
- package/docs/AdditionalInfo.md +0 -41
- package/docs/DefaultApi.md +0 -235
- package/docs/ESignature.md +0 -43
- package/docs/Handler.md +0 -41
- package/docs/HandlerSearch.md +0 -34
- package/docs/HandlerSearchSiteTypeEnum.md +0 -31
- package/docs/InfoApi.md +0 -81
- package/docs/Invitation.md +0 -42
- package/docs/LockReasonEnum.md +0 -31
- package/docs/Manifest.md +0 -93
- package/docs/ManifestApi.md +0 -907
- package/docs/ManifestPhone.md +0 -35
- package/docs/Membership.md +0 -42
- package/docs/Mtn.md +0 -39
- package/docs/MyProfileApi.md +0 -73
- package/docs/NullEnum.md +0 -30
- package/docs/OpenInvitation.md +0 -38
- package/docs/Org.md +0 -39
- package/docs/OrgsApi.md +0 -232
- package/docs/PaginatedInvitationList.md +0 -38
- package/docs/PaginatedMtnList.md +0 -38
- package/docs/PaginatedOrgList.md +0 -38
- package/docs/PaginatedSiteList.md +0 -38
- package/docs/PaginatedTeamList.md +0 -38
- package/docs/PaperSignature.md +0 -35
- package/docs/PatchedInvitation.md +0 -42
- package/docs/PatchedProfile.md +0 -35
- package/docs/PatchedRcrainfoProfile.md +0 -45
- package/docs/PatchedTeam.md +0 -48
- package/docs/Price.md +0 -42
- package/docs/Profile.md +0 -35
- package/docs/ProfileApi.md +0 -241
- package/docs/QuickerSign.md +0 -43
- package/docs/RcraAddress.md +0 -45
- package/docs/RcraContact.md +0 -43
- package/docs/RcraPhone.md +0 -35
- package/docs/RcraSite.md +0 -57
- package/docs/RcraSitePermission.md +0 -45
- package/docs/RcraSiteSiteTypeEnum.md +0 -31
- package/docs/RcrainfoProfile.md +0 -45
- package/docs/RoleEnum.md +0 -31
- package/docs/Signer.md +0 -49
- package/docs/Site.md +0 -35
- package/docs/SiteApi.md +0 -147
- package/docs/SiteManifestSyncRequest.md +0 -32
- package/docs/SiteManifestSyncResponse.md +0 -32
- package/docs/SitesApi.md +0 -155
- package/docs/StatusC23Enum.md +0 -31
- package/docs/Subscription.md +0 -51
- package/docs/SubscriptionItem.md +0 -36
- package/docs/SubscriptionStatusEnum.md +0 -31
- package/docs/SyncApi.md +0 -73
- package/docs/Team.md +0 -48
- package/docs/TeamsApi.md +0 -965
- package/docs/TrakUser.md +0 -43
- package/docs/Transporter.md +0 -41
- package/docs/UserInvitationsResponse.md +0 -32
- package/docs/WasteLine.md +0 -55
- package/models/AdditionalInfo.ts +0 -96
- package/models/AggregateEmployeeData.ts +0 -83
- package/models/DepartmentEnum.ts +0 -59
- package/models/ESignature.ts +0 -112
- package/models/Employee.ts +0 -125
- package/models/Handler.ts +0 -126
- package/models/HandlerSearch.ts +0 -84
- package/models/HandlerSearchSiteTypeEnum.ts +0 -57
- package/models/Invitation.ts +0 -116
- package/models/LockReasonEnum.ts +0 -55
- package/models/Manifest.ts +0 -353
- package/models/ManifestPhone.ts +0 -73
- package/models/Membership.ts +0 -115
- package/models/Mtn.ts +0 -98
- package/models/NullEnum.ts +0 -50
- package/models/OpenInvitation.ts +0 -88
- package/models/Org.ts +0 -88
- package/models/PaginatedEmployeeList.ts +0 -98
- package/models/PaginatedInvitationList.ts +0 -98
- package/models/PaginatedMtnList.ts +0 -98
- package/models/PaginatedOrgList.ts +0 -98
- package/models/PaginatedSiteList.ts +0 -98
- package/models/PaginatedTeamList.ts +0 -98
- package/models/PaperSignature.ts +0 -74
- package/models/PatchedEmployee.ts +0 -118
- package/models/PatchedInvitation.ts +0 -112
- package/models/PatchedProfile.ts +0 -79
- package/models/PatchedRcrainfoProfile.ts +0 -119
- package/models/PatchedTeam.ts +0 -143
- package/models/Price.ts +0 -106
- package/models/Profile.ts +0 -80
- package/models/QuickerSign.ts +0 -108
- package/models/RcraAddress.ts +0 -113
- package/models/RcraContact.ts +0 -112
- package/models/RcraPhone.ts +0 -73
- package/models/RcraSite.ts +0 -200
- package/models/RcraSitePermission.ts +0 -121
- package/models/RcraSiteSiteTypeEnum.ts +0 -57
- package/models/RcrainfoProfile.ts +0 -120
- package/models/RoleEnum.ts +0 -53
- package/models/Signer.ts +0 -136
- package/models/Site.ts +0 -81
- package/models/SiteManifestSyncRequest.ts +0 -65
- package/models/SiteManifestSyncResponse.ts +0 -65
- package/models/StatusC23Enum.ts +0 -67
- package/models/StatusEnum.ts +0 -63
- package/models/Subscription.ts +0 -168
- package/models/SubscriptionItem.ts +0 -90
- package/models/SubscriptionStatusEnum.ts +0 -63
- package/models/Team.ts +0 -151
- package/models/TrakUser.ts +0 -106
- package/models/Transporter.ts +0 -120
- package/models/UserInvitationsResponse.ts +0 -73
- package/models/WasteLine.ts +0 -157
- package/runtime.ts +0 -432
package/docs/StatusC23Enum.md
DELETED
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
# StatusC23Enum
|
|
3
|
-
|
|
4
|
-
* `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
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
Name | Type
|
|
9
|
-
------------ | -------------
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import type { StatusC23Enum } from ''
|
|
15
|
-
|
|
16
|
-
// TODO: Update the object below with actual values
|
|
17
|
-
const example = {
|
|
18
|
-
} satisfies StatusC23Enum
|
|
19
|
-
|
|
20
|
-
console.log(example)
|
|
21
|
-
|
|
22
|
-
// Convert the instance to a JSON string
|
|
23
|
-
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
-
console.log(exampleJSON)
|
|
25
|
-
|
|
26
|
-
// Parse the JSON string back to an object
|
|
27
|
-
const exampleParsed = JSON.parse(exampleJSON) as StatusC23Enum
|
|
28
|
-
console.log(exampleParsed)
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
[[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
DELETED
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
# Subscription
|
|
3
|
-
|
|
4
|
-
A serializer for Subscriptions which uses the SubscriptionWrapper object under the hood
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
Name | Type
|
|
9
|
-
------------ | -------------
|
|
10
|
-
`id` | string
|
|
11
|
-
`displayName` | string
|
|
12
|
-
`startDate` | Date
|
|
13
|
-
`billingInterval` | string
|
|
14
|
-
`currentPeriodStart` | Date
|
|
15
|
-
`currentPeriodEnd` | Date
|
|
16
|
-
`cancelAtPeriodEnd` | boolean
|
|
17
|
-
`status` | [SubscriptionStatusEnum](SubscriptionStatusEnum.md)
|
|
18
|
-
`quantity` | number
|
|
19
|
-
`items` | [Array<SubscriptionItem>](SubscriptionItem.md)
|
|
20
|
-
|
|
21
|
-
## Example
|
|
22
|
-
|
|
23
|
-
```typescript
|
|
24
|
-
import type { Subscription } from ''
|
|
25
|
-
|
|
26
|
-
// TODO: Update the object below with actual values
|
|
27
|
-
const example = {
|
|
28
|
-
"id": null,
|
|
29
|
-
"displayName": null,
|
|
30
|
-
"startDate": null,
|
|
31
|
-
"billingInterval": null,
|
|
32
|
-
"currentPeriodStart": null,
|
|
33
|
-
"currentPeriodEnd": null,
|
|
34
|
-
"cancelAtPeriodEnd": null,
|
|
35
|
-
"status": null,
|
|
36
|
-
"quantity": null,
|
|
37
|
-
"items": null,
|
|
38
|
-
} satisfies Subscription
|
|
39
|
-
|
|
40
|
-
console.log(example)
|
|
41
|
-
|
|
42
|
-
// Convert the instance to a JSON string
|
|
43
|
-
const exampleJSON: string = JSON.stringify(example)
|
|
44
|
-
console.log(exampleJSON)
|
|
45
|
-
|
|
46
|
-
// Parse the JSON string back to an object
|
|
47
|
-
const exampleParsed = JSON.parse(exampleJSON) as Subscription
|
|
48
|
-
console.log(exampleParsed)
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
[[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
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
# SubscriptionItem
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type
|
|
8
|
-
------------ | -------------
|
|
9
|
-
`id` | string
|
|
10
|
-
`price` | [Price](Price.md)
|
|
11
|
-
`quantity` | number
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import type { SubscriptionItem } from ''
|
|
17
|
-
|
|
18
|
-
// TODO: Update the object below with actual values
|
|
19
|
-
const example = {
|
|
20
|
-
"id": null,
|
|
21
|
-
"price": null,
|
|
22
|
-
"quantity": null,
|
|
23
|
-
} satisfies SubscriptionItem
|
|
24
|
-
|
|
25
|
-
console.log(example)
|
|
26
|
-
|
|
27
|
-
// Convert the instance to a JSON string
|
|
28
|
-
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
-
console.log(exampleJSON)
|
|
30
|
-
|
|
31
|
-
// Parse the JSON string back to an object
|
|
32
|
-
const exampleParsed = JSON.parse(exampleJSON) as SubscriptionItem
|
|
33
|
-
console.log(exampleParsed)
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
# SubscriptionStatusEnum
|
|
3
|
-
|
|
4
|
-
* `active` - Active * `canceled` - Canceled * `incomplete` - Incomplete * `incomplete_expired` - Incomplete Expired * `past_due` - Past due * `trialing` - Trialing * `unpaid` - Unpaid
|
|
5
|
-
|
|
6
|
-
## Properties
|
|
7
|
-
|
|
8
|
-
Name | Type
|
|
9
|
-
------------ | -------------
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import type { SubscriptionStatusEnum } from ''
|
|
15
|
-
|
|
16
|
-
// TODO: Update the object below with actual values
|
|
17
|
-
const example = {
|
|
18
|
-
} satisfies SubscriptionStatusEnum
|
|
19
|
-
|
|
20
|
-
console.log(example)
|
|
21
|
-
|
|
22
|
-
// Convert the instance to a JSON string
|
|
23
|
-
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
-
console.log(exampleJSON)
|
|
25
|
-
|
|
26
|
-
// Parse the JSON string back to an object
|
|
27
|
-
const exampleParsed = JSON.parse(exampleJSON) as SubscriptionStatusEnum
|
|
28
|
-
console.log(exampleParsed)
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
[[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
DELETED
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
# SyncApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
| [**syncCreate**](SyncApi.md#synccreate) | **POST** /api/v1/sync | |
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
## syncCreate
|
|
12
|
-
|
|
13
|
-
> syncCreate()
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
Create a job to sync the user\'s RCRAInfo profile.
|
|
18
|
-
|
|
19
|
-
### Example
|
|
20
|
-
|
|
21
|
-
```ts
|
|
22
|
-
import {
|
|
23
|
-
Configuration,
|
|
24
|
-
SyncApi,
|
|
25
|
-
} from '';
|
|
26
|
-
import type { SyncCreateRequest } from '';
|
|
27
|
-
|
|
28
|
-
async function example() {
|
|
29
|
-
console.log("🚀 Testing SDK...");
|
|
30
|
-
const config = new Configuration({
|
|
31
|
-
// To configure API key authorization: cookieAuth
|
|
32
|
-
apiKey: "YOUR API KEY",
|
|
33
|
-
// To configure API key authorization: ApiKeyAuth
|
|
34
|
-
apiKey: "YOUR API KEY",
|
|
35
|
-
});
|
|
36
|
-
const api = new SyncApi(config);
|
|
37
|
-
|
|
38
|
-
try {
|
|
39
|
-
const data = await api.syncCreate();
|
|
40
|
-
console.log(data);
|
|
41
|
-
} catch (error) {
|
|
42
|
-
console.error(error);
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
// Run the test
|
|
47
|
-
example().catch(console.error);
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
### Parameters
|
|
51
|
-
|
|
52
|
-
This endpoint does not need any parameter.
|
|
53
|
-
|
|
54
|
-
### Return type
|
|
55
|
-
|
|
56
|
-
`void` (Empty response body)
|
|
57
|
-
|
|
58
|
-
### Authorization
|
|
59
|
-
|
|
60
|
-
[cookieAuth](../README.md#cookieAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
61
|
-
|
|
62
|
-
### HTTP request headers
|
|
63
|
-
|
|
64
|
-
- **Content-Type**: Not defined
|
|
65
|
-
- **Accept**: Not defined
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
### HTTP response details
|
|
69
|
-
| Status code | Description | Response headers |
|
|
70
|
-
|-------------|-------------|------------------|
|
|
71
|
-
| **200** | No response body | - |
|
|
72
|
-
|
|
73
|
-
[[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
DELETED
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
# Team
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type
|
|
8
|
-
------------ | -------------
|
|
9
|
-
`id` | number
|
|
10
|
-
`name` | string
|
|
11
|
-
`slug` | string
|
|
12
|
-
`members` | [Array<Membership>](Membership.md)
|
|
13
|
-
`invitations` | [Array<Invitation>](Invitation.md)
|
|
14
|
-
`dashboardUrl` | string
|
|
15
|
-
`isAdmin` | boolean
|
|
16
|
-
`subscription` | [Subscription](Subscription.md)
|
|
17
|
-
`hasActiveSubscription` | boolean
|
|
18
|
-
|
|
19
|
-
## Example
|
|
20
|
-
|
|
21
|
-
```typescript
|
|
22
|
-
import type { Team } from ''
|
|
23
|
-
|
|
24
|
-
// TODO: Update the object below with actual values
|
|
25
|
-
const example = {
|
|
26
|
-
"id": null,
|
|
27
|
-
"name": null,
|
|
28
|
-
"slug": null,
|
|
29
|
-
"members": null,
|
|
30
|
-
"invitations": null,
|
|
31
|
-
"dashboardUrl": null,
|
|
32
|
-
"isAdmin": null,
|
|
33
|
-
"subscription": null,
|
|
34
|
-
"hasActiveSubscription": null,
|
|
35
|
-
} satisfies Team
|
|
36
|
-
|
|
37
|
-
console.log(example)
|
|
38
|
-
|
|
39
|
-
// Convert the instance to a JSON string
|
|
40
|
-
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
-
console.log(exampleJSON)
|
|
42
|
-
|
|
43
|
-
// Parse the JSON string back to an object
|
|
44
|
-
const exampleParsed = JSON.parse(exampleJSON) as Team
|
|
45
|
-
console.log(exampleParsed)
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|