@connectedxm/admin-sdk 6.9.0 → 6.14.5

package/docs/SeriesQuestionChoice.md

@@ -0,0 +1,38 @@
+# SeriesQuestionChoice
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**value** | **string** |  | [default to undefined]
+**text** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**supply** | **number** |  | [default to undefined]
+**sortOrder** | **number** |  | [default to undefined]
+**questionId** | **string** |  | [default to undefined]
+**question** | [**BaseSeriesQuestion**](BaseSeriesQuestion.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesQuestionChoice } from '@connectedxm/admin-sdk';
+
+const instance: SeriesQuestionChoice = {
+    id,
+    value,
+    text,
+    description,
+    supply,
+    sortOrder,
+    questionId,
+    question,
+    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/SeriesQuestionChoiceCreateInputs.md

@@ -0,0 +1,28 @@
+# SeriesQuestionChoiceCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **string** |  | [default to undefined]
+**text** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**supply** | **number** |  | [optional] [default to undefined]
+**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesQuestionChoiceCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: SeriesQuestionChoiceCreateInputs = {
+    value,
+    text,
+    description,
+    supply,
+    sortOrder,
+};
+```
+
+[[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/SeriesQuestionChoiceTranslation.md

@@ -0,0 +1,32 @@
+# SeriesQuestionChoiceTranslation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**locale** | **string** |  | [default to undefined]
+**value** | **string** |  | [default to undefined]
+**text** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesQuestionChoiceTranslation } from '@connectedxm/admin-sdk';
+
+const instance: SeriesQuestionChoiceTranslation = {
+    id,
+    locale,
+    value,
+    text,
+    description,
+    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/SeriesQuestionChoiceUpdateInputs.md

@@ -0,0 +1,28 @@
+# SeriesQuestionChoiceUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **string** |  | [optional] [default to undefined]
+**text** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**supply** | **number** |  | [optional] [default to undefined]
+**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesQuestionChoiceUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: SeriesQuestionChoiceUpdateInputs = {
+    value,
+    text,
+    description,
+    supply,
+    sortOrder,
+};
+```
+
+[[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/SeriesQuestionCreateInputs.md

@@ -0,0 +1,56 @@
+# SeriesQuestionCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**type** | [**SeriesQuestionType**](SeriesQuestionType.md) |  | [default to undefined]
+**required** | **boolean** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**placeholder** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**_default** | **string** |  | [optional] [default to undefined]
+**dashboardVisibility** | **boolean** |  | [optional] [default to undefined]
+**mutable** | **boolean** |  | [optional] [default to undefined]
+**min** | **string** |  | [optional] [default to undefined]
+**max** | **string** |  | [optional] [default to undefined]
+**masked** | **boolean** |  | [optional] [default to undefined]
+**validation** | **string** |  | [optional] [default to undefined]
+**validationMessage** | **string** |  | [optional] [default to undefined]
+**locationOption** | [**LocationQuestionOption**](LocationQuestionOption.md) |  | [optional] [default to undefined]
+**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) |  | [optional] [default to undefined]
+**featured** | **boolean** |  | [optional] [default to undefined]
+**searchListId** | **string** |  | [optional] [default to undefined]
+**choices** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesQuestionCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: SeriesQuestionCreateInputs = {
+    name,
+    type,
+    required,
+    label,
+    placeholder,
+    description,
+    _default,
+    dashboardVisibility,
+    mutable,
+    min,
+    max,
+    masked,
+    validation,
+    validationMessage,
+    locationOption,
+    sortOrder,
+    featured,
+    searchListId,
+    choices,
+};
+```
+
+[[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/SeriesQuestionTranslation.md

@@ -0,0 +1,32 @@
+# SeriesQuestionTranslation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**locale** | **string** |  | [default to undefined]
+**label** | **string** |  | [default to undefined]
+**placeholder** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesQuestionTranslation } from '@connectedxm/admin-sdk';
+
+const instance: SeriesQuestionTranslation = {
+    id,
+    locale,
+    label,
+    placeholder,
+    description,
+    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/SeriesQuestionTranslationUpdateInputs.md

@@ -0,0 +1,24 @@
+# SeriesQuestionTranslationUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **string** |  | [optional] [default to undefined]
+**placeholder** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesQuestionTranslationUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: SeriesQuestionTranslationUpdateInputs = {
+    label,
+    placeholder,
+    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/SeriesQuestionType.md

@@ -0,0 +1,30 @@
+# SeriesQuestionType
+
+
+## Enum
+
+* `Text` (value: `'text'`)
+
+* `Textarea` (value: `'textarea'`)
+
+* `Number` (value: `'number'`)
+
+* `Time` (value: `'time'`)
+
+* `Date` (value: `'date'`)
+
+* `Toggle` (value: `'toggle'`)
+
+* `Select` (value: `'select'`)
+
+* `Radio` (value: `'radio'`)
+
+* `Checkbox` (value: `'checkbox'`)
+
+* `Search` (value: `'search'`)
+
+* `File` (value: `'file'`)
+
+* `Location` (value: `'location'`)
+
+[[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/SeriesQuestionUpdateInputs.md

@@ -0,0 +1,56 @@
+# SeriesQuestionUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**type** | [**SeriesQuestionType**](SeriesQuestionType.md) |  | [optional] [default to undefined]
+**required** | **boolean** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**placeholder** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**_default** | **string** |  | [optional] [default to undefined]
+**dashboardVisibility** | **boolean** |  | [optional] [default to undefined]
+**mutable** | **boolean** |  | [optional] [default to undefined]
+**min** | **string** |  | [optional] [default to undefined]
+**max** | **string** |  | [optional] [default to undefined]
+**masked** | **boolean** |  | [optional] [default to undefined]
+**validation** | **string** |  | [optional] [default to undefined]
+**validationMessage** | **string** |  | [optional] [default to undefined]
+**locationOption** | [**LocationQuestionOption**](LocationQuestionOption.md) |  | [optional] [default to undefined]
+**sortOrder** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) |  | [optional] [default to undefined]
+**featured** | **boolean** |  | [optional] [default to undefined]
+**searchListId** | **string** |  | [optional] [default to undefined]
+**choices** | [**SeriesQuestionUpdateInputsChoices**](SeriesQuestionUpdateInputsChoices.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesQuestionUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: SeriesQuestionUpdateInputs = {
+    name,
+    type,
+    required,
+    label,
+    placeholder,
+    description,
+    _default,
+    dashboardVisibility,
+    mutable,
+    min,
+    max,
+    masked,
+    validation,
+    validationMessage,
+    locationOption,
+    sortOrder,
+    featured,
+    searchListId,
+    choices,
+};
+```
+
+[[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/SeriesQuestionUpdateInputsChoices.md

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