@connectedxm/admin-sdk 1.0.0

package/docs/SurveysSubmissionsApi.md

@@ -0,0 +1,435 @@
+# SurveysSubmissionsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteSurveySubmission**](#deletesurveysubmission) | **DELETE** /surveys/{surveyId}/submissions/{submissionId} | Delete Survey Submission|
+|[**getSurveySubmission**](#getsurveysubmission) | **GET** /surveys/{surveyId}/submissions/{submissionId} | Get Survey Submission|
+|[**getSurveySubmissionQuestionSections**](#getsurveysubmissionquestionsections) | **GET** /surveys/{surveyId}/submissions/{submissionId}/sections | Get Survey Submission Question Sections|
+|[**getSurveySubmissionResponseChanges**](#getsurveysubmissionresponsechanges) | **GET** /surveys/{surveyId}/submissions/{submissionId}/responses/{questionId}/changes | Get Survey Submission Response Changes|
+|[**getSurveySubmissions**](#getsurveysubmissions) | **GET** /surveys/{surveyId}/submissions | Get Survey Submissions|
+|[**updateSurveySubmission**](#updatesurveysubmission) | **PUT** /surveys/{surveyId}/submissions/{submissionId} | Update Survey Submission|
+|[**updateSurveySubmissionResponses**](#updatesurveysubmissionresponses) | **PUT** /surveys/{surveyId}/submissions/{submissionId}/responses | Update Survey Submission Responses|
+
+# **deleteSurveySubmission**
+> CreateAccountInvitations200Response deleteSurveySubmission()
+
+Delete Survey Submission endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSubmissionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSubmissionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let submissionId: string; //The submission identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteSurveySubmission(
+    surveyId,
+    submissionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **submissionId** | [**string**] | The submission identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountInvitations200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getSurveySubmission**
+> CreateAccountAddress200Response getSurveySubmission()
+
+Get Survey Submission endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSubmissionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSubmissionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let submissionId: string; //The submission identifier (default to undefined)
+
+const { status, data } = await apiInstance.getSurveySubmission(
+    surveyId,
+    submissionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **submissionId** | [**string**] | The submission identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getSurveySubmissionQuestionSections**
+> GetAccountInvitations200Response getSurveySubmissionQuestionSections()
+
+Get Survey Submission Question Sections endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSubmissionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSubmissionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let submissionId: string; //The submission identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSurveySubmissionQuestionSections(
+    surveyId,
+    submissionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **submissionId** | [**string**] | The submission identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAccountInvitations200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getSurveySubmissionResponseChanges**
+> GetAccountInvitations200Response getSurveySubmissionResponseChanges()
+
+Get Survey Submission Response Changes endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSubmissionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSubmissionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let submissionId: string; //The submission identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSurveySubmissionResponseChanges(
+    surveyId,
+    submissionId,
+    questionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **submissionId** | [**string**] | The submission identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAccountInvitations200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getSurveySubmissions**
+> GetAccountInvitations200Response getSurveySubmissions()
+
+Get Survey Submissions endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSubmissionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSubmissionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSurveySubmissions(
+    surveyId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAccountInvitations200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateSurveySubmission**
+> CreateAccountAddress200Response updateSurveySubmission(surveySubmissionUpdateInputs)
+
+Update Survey Submission endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSubmissionsApi,
+    Configuration,
+    SurveySubmissionUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSubmissionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let submissionId: string; //The submission identifier (default to undefined)
+let surveySubmissionUpdateInputs: SurveySubmissionUpdateInputs; //
+
+const { status, data } = await apiInstance.updateSurveySubmission(
+    surveyId,
+    submissionId,
+    surveySubmissionUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveySubmissionUpdateInputs** | **SurveySubmissionUpdateInputs**|  | |
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **submissionId** | [**string**] | The submission identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updateSurveySubmissionResponses**
+> CreateAccountAddress200Response updateSurveySubmissionResponses(requestBody)
+
+Update Survey Submission Responses endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSubmissionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSubmissionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let submissionId: string; //The submission identifier (default to undefined)
+let requestBody: Array<object>; //
+
+const { status, data } = await apiInstance.updateSurveySubmissionResponses(
+    surveyId,
+    submissionId,
+    requestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **requestBody** | **Array<object>**|  | |
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **submissionId** | [**string**] | The submission identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/SystemEventLog.md

@@ -0,0 +1,32 @@
+# SystemEventLog
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**organizationId** | **string** |  | [default to undefined]
+**status** | [**SystemEventLogStatus**](SystemEventLogStatus.md) |  | [default to undefined]
+**trigger** | **string** |  | [default to undefined]
+**progress** | **{ [key: string]: any; }** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SystemEventLog } from '@connectedxm/admin-sdk';
+
+const instance: SystemEventLog = {
+    id,
+    organizationId,
+    status,
+    trigger,
+    progress,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SystemEventLogStatus.md

@@ -0,0 +1,10 @@
+# SystemEventLogStatus
+
+
+## Enum
+
+* `Pending` (value: `'pending'`)
+
+* `Completed` (value: `'completed'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TableChartSummaryData.md

@@ -0,0 +1,26 @@
+# TableChartSummaryData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**data** | [**Array<TableChartSummaryDataDataInner>**](TableChartSummaryDataDataInner.md) |  | [default to undefined]
+**count** | **number** |  | [default to undefined]
+**question** | [**RegistrationQuestion**](RegistrationQuestion.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableChartSummaryData } from '@connectedxm/admin-sdk';
+
+const instance: TableChartSummaryData = {
+    type,
+    data,
+    count,
+    question,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TableChartSummaryDataDataInner.md

@@ -0,0 +1,20 @@
+# TableChartSummaryDataDataInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TableChartSummaryDataDataInner } from '@connectedxm/admin-sdk';
+
+const instance: TableChartSummaryDataDataInner = {
+    value,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TaxCode.md

@@ -0,0 +1,22 @@
+# TaxCode
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TaxCode } from '@connectedxm/admin-sdk';
+
+const instance: TaxCode = {
+    code,
+    description,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TaxIntegration.md

@@ -0,0 +1,54 @@
+# TaxIntegration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | [**TaxIntegrationType**](TaxIntegrationType.md) |  | [default to undefined]
+**connectionId** | **string** |  | [default to undefined]
+**sandbox** | **boolean** |  | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+**companyCode** | **string** |  | [default to undefined]
+**commit** | **boolean** |  | [default to undefined]
+**logging** | **boolean** |  | [default to undefined]
+**passTaxCode** | **string** |  | [default to undefined]
+**packageTaxCode** | **string** |  | [default to undefined]
+**reservationTaxCode** | **string** |  | [default to undefined]
+**addOnTaxCode** | **string** |  | [default to undefined]
+**accessTaxCode** | **string** |  | [default to undefined]
+**invoiceTaxCode** | **string** |  | [default to undefined]
+**bookingTaxCode** | **string** |  | [default to undefined]
+**couponTaxCode** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TaxIntegration } from '@connectedxm/admin-sdk';
+
+const instance: TaxIntegration = {
+    id,
+    type,
+    connectionId,
+    sandbox,
+    enabled,
+    companyCode,
+    commit,
+    logging,
+    passTaxCode,
+    packageTaxCode,
+    reservationTaxCode,
+    addOnTaxCode,
+    accessTaxCode,
+    invoiceTaxCode,
+    bookingTaxCode,
+    couponTaxCode,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TaxIntegrationCreateInputs.md

@@ -0,0 +1,26 @@
+# TaxIntegrationCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sandbox** | **boolean** |  | [optional] [default to undefined]
+**apiKey** | **string** |  | [optional] [default to undefined]
+**accountId** | **string** |  | [optional] [default to undefined]
+**licenseKey** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TaxIntegrationCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: TaxIntegrationCreateInputs = {
+    sandbox,
+    apiKey,
+    accountId,
+    licenseKey,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TaxIntegrationLog.md

@@ -0,0 +1,22 @@
+# TaxIntegrationLog
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request** | **object** |  | [default to undefined]
+**response** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { TaxIntegrationLog } from '@connectedxm/admin-sdk';
+
+const instance: TaxIntegrationLog = {
+    request,
+    response,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TaxIntegrationLogType.md

@@ -0,0 +1,12 @@
+# TaxIntegrationLogType
+
+
+## Enum
+
+* `Quote` (value: `'quote'`)
+
+* `Record` (value: `'record'`)
+
+* `Refund` (value: `'refund'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TaxIntegrationType.md

@@ -0,0 +1,14 @@
+# TaxIntegrationType
+
+
+## Enum
+
+* `Stripe` (value: `'stripe'`)
+
+* `Taxjar` (value: `'taxjar'`)
+
+* `Vertex` (value: `'vertex'`)
+
+* `Avalara` (value: `'avalara'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)