diff --git a/docs/api/OapApiV1.md b/docs/api/OapApiV1.md deleted file mode 100644 index 187b96e..0000000 --- a/docs/api/OapApiV1.md +++ /dev/null @@ -1,30 +0,0 @@ -# OapApiV1 - -URL: [`https://oaprotection.org/api/v1`](https://oaprotection.org/api/v1) - -| method | path | description | -| --- | --- | --- | -| [getApplications](OapApiV1/getApplications.md) | `GET /applications` | Gets applications for the current user. | -| [createApplication](OapApiV1/createApplication.md) | `POST /applications/` | Creates a new application for the current user. | -| [getApplication](OapApiV1/getApplication.md) | `GET /applications/{id}` | Gets the specified application for the current user. | -| [updateApplication](OapApiV1/updateApplication.md) | `PATCH /applications/{id}` | Updates the application. | - -| data | description | -| --- | --- | -| [Application](OapApiV1/Application.md) | An application. | -| [ApplicationCreateSet](OapApiV1/ApplicationCreateSet.md) | | -| [ApplicationChangeSet](OapApiV1/ApplicationChangeSet.md) | | -| [ApplicationTermsCreateSet](OapApiV1/ApplicationTermsCreateSet.md) | | -| [ApplicationTerms](OapApiV1/ApplicationTerms.md) | | - -| enum | description | -| --- | --- | -| [ApplicationStatus](OapApiV1/ApplicationStatus.md) | | - -API providing OAP functionality for the application form, calculator and more. - -## Heading - -Use a primary heading to indicate the member name. - - diff --git a/docs/api/OapApiV1/Application.md b/docs/api/OapApiV1/Application.md deleted file mode 100644 index 6f3bafc..0000000 --- a/docs/api/OapApiV1/Application.md +++ /dev/null @@ -1,21 +0,0 @@ -# Application - -An application. - -``` -{ - "id": "(string)", - "status": "(InProgress|Submitted)", - "terms": { "hasReadInstructions": ... } -} -``` - -| field | type | description | -| --- | --- | --- | -| id | string | A unique identifier for the application. | -| status | [ApplicationStatus](ApplicationStatus.md) | The current status of this application. | -| terms | [ApplicationTerms](ApplicationTerms.md) | Terms the user must accept to start, continue an accept an application. | - -Represents a user's application, whether in progress or submitted. - - diff --git a/docs/api/OapApiV1/ApplicationChangeSet.md b/docs/api/OapApiV1/ApplicationChangeSet.md deleted file mode 100644 index 3f54c93..0000000 --- a/docs/api/OapApiV1/ApplicationChangeSet.md +++ /dev/null @@ -1,8 +0,0 @@ -# ApplicationChangeSet - -``` -{ -} -``` - - diff --git a/docs/api/OapApiV1/ApplicationCreateSet.md b/docs/api/OapApiV1/ApplicationCreateSet.md deleted file mode 100644 index 07a38b3..0000000 --- a/docs/api/OapApiV1/ApplicationCreateSet.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApplicationCreateSet - -``` -{ - "terms": { "hasReadInstructions": ... } -} -``` - -| field | type | description | -| --- | --- | --- | -| terms | [ApplicationTermsCreateSet](ApplicationTermsCreateSet.md) | Terms a user must accept to start an application. | - - diff --git a/docs/api/OapApiV1/ApplicationStatus.md b/docs/api/OapApiV1/ApplicationStatus.md deleted file mode 100644 index 9a7c0d6..0000000 --- a/docs/api/OapApiV1/ApplicationStatus.md +++ /dev/null @@ -1,8 +0,0 @@ -# ApplicationStatus - -| name | description | -| --- | --- | -| InProgress | | -| Submitted | | - - diff --git a/docs/api/OapApiV1/ApplicationTerms.md b/docs/api/OapApiV1/ApplicationTerms.md deleted file mode 100644 index d101513..0000000 --- a/docs/api/OapApiV1/ApplicationTerms.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApplicationTerms - -``` -{ - "hasReadInstructions": (true|false) -} -``` - -| field | type | description | -| --- | --- | --- | -| hasReadInstructions | boolean | | - - diff --git a/docs/api/OapApiV1/ApplicationTermsCreateSet.md b/docs/api/OapApiV1/ApplicationTermsCreateSet.md deleted file mode 100644 index dde7333..0000000 --- a/docs/api/OapApiV1/ApplicationTermsCreateSet.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApplicationTermsCreateSet - -``` -{ - "hasReadInstructions": (true|false) -} -``` - -| field | type | description | -| --- | --- | --- | -| hasReadInstructions | boolean | | - - diff --git a/docs/api/OapApiV1/createApplication.md b/docs/api/OapApiV1/createApplication.md deleted file mode 100644 index 8b9b91e..0000000 --- a/docs/api/OapApiV1/createApplication.md +++ /dev/null @@ -1,23 +0,0 @@ -# createApplication - -Creates a new application for the current user. - -``` -POST /applications/ -(applicationCreateSet) ---- 200 OK -(application) ---- 201 Created -``` - -| request | type | description | -| --- | --- | --- | -| applicationCreateSet | [ApplicationCreateSet](ApplicationCreateSet.md) | The application to create. | - -| response | type | description | -| --- | --- | --- | -| application | [Application](Application.md) | The created application. | - -Creates a new application for the current user. - - diff --git a/docs/api/OapApiV1/getApplication.md b/docs/api/OapApiV1/getApplication.md deleted file mode 100644 index 954a1c8..0000000 --- a/docs/api/OapApiV1/getApplication.md +++ /dev/null @@ -1,25 +0,0 @@ -# getApplication - -Gets the specified application for the current user. - -``` -GET /applications/{id} ---- response -eTag: (eTag) ---- 200 OK -(application) ---- 304 Not Modified -(if notModified) -``` - -| request | type | description | -| --- | --- | --- | -| id | string | The widget ID. | - -| response | type | description | -| --- | --- | --- | -| application | [Application](Application.md) | The requested widget. | -| eTag | string | | -| notModified | boolean | | - - diff --git a/docs/api/OapApiV1/getApplications.md b/docs/api/OapApiV1/getApplications.md deleted file mode 100644 index a16339c..0000000 --- a/docs/api/OapApiV1/getApplications.md +++ /dev/null @@ -1,34 +0,0 @@ -# getApplications - -Gets applications for the current user. - -``` -GET /applications - ?status={status} - &limit={limit} - &nextToken={nextToken} ---- 200 OK -{ - "applications": [ { "id": ... }, ... ], - "total": (integer), - "nextToken": "(string)", - "isLastPage": (true|false) -} -``` - -| request | type | description | -| --- | --- | --- | -| status | [ApplicationStatus](ApplicationStatus.md) | Filter applications by the given status. | -| limit | int32 | The limit of returned results. | -| nextToken | string | The token presenting the next page of applications to get. | - -| response | type | description | -| --- | --- | --- | -| applications | [Application](Application.md)[] | The applications. | -| total | int64 | The total number of applications. | -| nextToken | string | The token representing the next page of results. | -| isLastPage | boolean | True if this is the last page of results, false otherwise. | - -Gets the current user's applications in pages. - - diff --git a/docs/api/OapApiV1/updateApplication.md b/docs/api/OapApiV1/updateApplication.md deleted file mode 100644 index 9f9a96f..0000000 --- a/docs/api/OapApiV1/updateApplication.md +++ /dev/null @@ -1,23 +0,0 @@ -# updateApplication - -Updates the application. - -``` -PATCH /applications/{id} -(applicationChangeSet) ---- 200 OK -(application) -``` - -| request | type | description | -| --- | --- | --- | -| id | string | The application ID. | -| applicationChangeSet | [ApplicationChangeSet](ApplicationChangeSet.md) | The application update set. | - -| response | type | description | -| --- | --- | --- | -| application | [Application](Application.md) | The updated Application. | - -Updates an application for the current user, given the ID of the application to update. - - diff --git a/docs/api/OverseasAutoProtectionApi.md b/docs/api/OverseasAutoProtectionApi.md deleted file mode 100644 index 9d74635..0000000 --- a/docs/api/OverseasAutoProtectionApi.md +++ /dev/null @@ -1,30 +0,0 @@ -# OverseasAutoProtectionApi - -URL: [`https://oaprotection.org/api/v1`](https://oaprotection.org/api/v1) - -| method | path | description | -| --- | --- | --- | -| [getApplications](OverseasAutoProtectionApi/getApplications.md) | `GET /applications` | Gets applications for the current user. | -| [createApplication](OverseasAutoProtectionApi/createApplication.md) | `POST /applications/` | Creates a new application for the current user. | -| [getApplication](OverseasAutoProtectionApi/getApplication.md) | `GET /applications/{id}` | Gets the specified application for the current user. | -| [updateApplication](OverseasAutoProtectionApi/updateApplication.md) | `PATCH /applications/{id}` | Updates the application. | - -| data | description | -| --- | --- | -| [Application](OverseasAutoProtectionApi/Application.md) | An application. | -| [ApplicationCreateSet](OverseasAutoProtectionApi/ApplicationCreateSet.md) | | -| [ApplicationChangeSet](OverseasAutoProtectionApi/ApplicationChangeSet.md) | | -| [ApplicationTermsCreateSet](OverseasAutoProtectionApi/ApplicationTermsCreateSet.md) | | -| [ApplicationTerms](OverseasAutoProtectionApi/ApplicationTerms.md) | | - -| enum | description | -| --- | --- | -| [ApplicationStatus](OverseasAutoProtectionApi/ApplicationStatus.md) | | - -API providing OAP functionality for the application form, calculator and more. - -## Heading - -Use a primary heading to indicate the member name. - - diff --git a/docs/api/OverseasAutoProtectionApi/Application.md b/docs/api/OverseasAutoProtectionApi/Application.md deleted file mode 100644 index 6f3bafc..0000000 --- a/docs/api/OverseasAutoProtectionApi/Application.md +++ /dev/null @@ -1,21 +0,0 @@ -# Application - -An application. - -``` -{ - "id": "(string)", - "status": "(InProgress|Submitted)", - "terms": { "hasReadInstructions": ... } -} -``` - -| field | type | description | -| --- | --- | --- | -| id | string | A unique identifier for the application. | -| status | [ApplicationStatus](ApplicationStatus.md) | The current status of this application. | -| terms | [ApplicationTerms](ApplicationTerms.md) | Terms the user must accept to start, continue an accept an application. | - -Represents a user's application, whether in progress or submitted. - - diff --git a/docs/api/OverseasAutoProtectionApi/ApplicationChangeSet.md b/docs/api/OverseasAutoProtectionApi/ApplicationChangeSet.md deleted file mode 100644 index 3f54c93..0000000 --- a/docs/api/OverseasAutoProtectionApi/ApplicationChangeSet.md +++ /dev/null @@ -1,8 +0,0 @@ -# ApplicationChangeSet - -``` -{ -} -``` - - diff --git a/docs/api/OverseasAutoProtectionApi/ApplicationCreateSet.md b/docs/api/OverseasAutoProtectionApi/ApplicationCreateSet.md deleted file mode 100644 index 07a38b3..0000000 --- a/docs/api/OverseasAutoProtectionApi/ApplicationCreateSet.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApplicationCreateSet - -``` -{ - "terms": { "hasReadInstructions": ... } -} -``` - -| field | type | description | -| --- | --- | --- | -| terms | [ApplicationTermsCreateSet](ApplicationTermsCreateSet.md) | Terms a user must accept to start an application. | - - diff --git a/docs/api/OverseasAutoProtectionApi/ApplicationStatus.md b/docs/api/OverseasAutoProtectionApi/ApplicationStatus.md deleted file mode 100644 index 9a7c0d6..0000000 --- a/docs/api/OverseasAutoProtectionApi/ApplicationStatus.md +++ /dev/null @@ -1,8 +0,0 @@ -# ApplicationStatus - -| name | description | -| --- | --- | -| InProgress | | -| Submitted | | - - diff --git a/docs/api/OverseasAutoProtectionApi/ApplicationTerms.md b/docs/api/OverseasAutoProtectionApi/ApplicationTerms.md deleted file mode 100644 index d101513..0000000 --- a/docs/api/OverseasAutoProtectionApi/ApplicationTerms.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApplicationTerms - -``` -{ - "hasReadInstructions": (true|false) -} -``` - -| field | type | description | -| --- | --- | --- | -| hasReadInstructions | boolean | | - - diff --git a/docs/api/OverseasAutoProtectionApi/ApplicationTermsCreateSet.md b/docs/api/OverseasAutoProtectionApi/ApplicationTermsCreateSet.md deleted file mode 100644 index dde7333..0000000 --- a/docs/api/OverseasAutoProtectionApi/ApplicationTermsCreateSet.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApplicationTermsCreateSet - -``` -{ - "hasReadInstructions": (true|false) -} -``` - -| field | type | description | -| --- | --- | --- | -| hasReadInstructions | boolean | | - - diff --git a/docs/api/OverseasAutoProtectionApi/createApplication.md b/docs/api/OverseasAutoProtectionApi/createApplication.md deleted file mode 100644 index 8b9b91e..0000000 --- a/docs/api/OverseasAutoProtectionApi/createApplication.md +++ /dev/null @@ -1,23 +0,0 @@ -# createApplication - -Creates a new application for the current user. - -``` -POST /applications/ -(applicationCreateSet) ---- 200 OK -(application) ---- 201 Created -``` - -| request | type | description | -| --- | --- | --- | -| applicationCreateSet | [ApplicationCreateSet](ApplicationCreateSet.md) | The application to create. | - -| response | type | description | -| --- | --- | --- | -| application | [Application](Application.md) | The created application. | - -Creates a new application for the current user. - - diff --git a/docs/api/OverseasAutoProtectionApi/getApplication.md b/docs/api/OverseasAutoProtectionApi/getApplication.md deleted file mode 100644 index 954a1c8..0000000 --- a/docs/api/OverseasAutoProtectionApi/getApplication.md +++ /dev/null @@ -1,25 +0,0 @@ -# getApplication - -Gets the specified application for the current user. - -``` -GET /applications/{id} ---- response -eTag: (eTag) ---- 200 OK -(application) ---- 304 Not Modified -(if notModified) -``` - -| request | type | description | -| --- | --- | --- | -| id | string | The widget ID. | - -| response | type | description | -| --- | --- | --- | -| application | [Application](Application.md) | The requested widget. | -| eTag | string | | -| notModified | boolean | | - - diff --git a/docs/api/OverseasAutoProtectionApi/getApplications.md b/docs/api/OverseasAutoProtectionApi/getApplications.md deleted file mode 100644 index a16339c..0000000 --- a/docs/api/OverseasAutoProtectionApi/getApplications.md +++ /dev/null @@ -1,34 +0,0 @@ -# getApplications - -Gets applications for the current user. - -``` -GET /applications - ?status={status} - &limit={limit} - &nextToken={nextToken} ---- 200 OK -{ - "applications": [ { "id": ... }, ... ], - "total": (integer), - "nextToken": "(string)", - "isLastPage": (true|false) -} -``` - -| request | type | description | -| --- | --- | --- | -| status | [ApplicationStatus](ApplicationStatus.md) | Filter applications by the given status. | -| limit | int32 | The limit of returned results. | -| nextToken | string | The token presenting the next page of applications to get. | - -| response | type | description | -| --- | --- | --- | -| applications | [Application](Application.md)[] | The applications. | -| total | int64 | The total number of applications. | -| nextToken | string | The token representing the next page of results. | -| isLastPage | boolean | True if this is the last page of results, false otherwise. | - -Gets the current user's applications in pages. - - diff --git a/docs/api/OverseasAutoProtectionApi/updateApplication.md b/docs/api/OverseasAutoProtectionApi/updateApplication.md deleted file mode 100644 index 9f9a96f..0000000 --- a/docs/api/OverseasAutoProtectionApi/updateApplication.md +++ /dev/null @@ -1,23 +0,0 @@ -# updateApplication - -Updates the application. - -``` -PATCH /applications/{id} -(applicationChangeSet) ---- 200 OK -(application) -``` - -| request | type | description | -| --- | --- | --- | -| id | string | The application ID. | -| applicationChangeSet | [ApplicationChangeSet](ApplicationChangeSet.md) | The application update set. | - -| response | type | description | -| --- | --- | --- | -| application | [Application](Application.md) | The updated Application. | - -Updates an application for the current user, given the ID of the application to update. - -