scale-gp-beta 0.1.0a2__py3-none-any.whl

scale_gp/types/question.py

@@ -0,0 +1,68 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["Question", "Choice", "NumberOptions", "RatingOptions"]
+
+
+class Choice(BaseModel):
+    label: str
+
+    value: Union[str, bool, float]
+
+    audit_required: Optional[bool] = None
+
+
+class NumberOptions(BaseModel):
+    max: Optional[float] = None
+    """Maximum value for the number"""
+
+    min: Optional[float] = None
+    """Minimum value for the number"""
+
+
+class RatingOptions(BaseModel):
+    max_label: str = FieldInfo(alias="maxLabel")
+    """Maximum value for the rating"""
+
+    min_label: str = FieldInfo(alias="minLabel")
+    """Minimum value for the rating"""
+
+    scale_steps: int = FieldInfo(alias="scaleSteps")
+    """Number of steps in the rating scale"""
+
+
+class Question(BaseModel):
+    id: str
+
+    created_at: datetime
+
+    created_by_user_id: str
+
+    prompt: str
+
+    title: str
+
+    type: Literal["categorical", "free_text", "rating", "number"]
+
+    choices: Optional[List[Choice]] = None
+
+    conditions: Optional[List[Dict[str, object]]] = None
+
+    dropdown: Optional[bool] = None
+
+    multi: Optional[bool] = None
+
+    number_options: Optional[NumberOptions] = FieldInfo(alias="numberOptions", default=None)
+
+    object: Optional[Literal["question"]] = None
+
+    rating_options: Optional[RatingOptions] = FieldInfo(alias="ratingOptions", default=None)
+
+    required: Optional[bool] = None

scale_gp/types/question_create_params.py

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Iterable
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["QuestionCreateParams", "Choice", "NumberOptions", "RatingOptions"]
+
+
+class QuestionCreateParams(TypedDict, total=False):
+    prompt: Required[str]
+
+    title: Required[str]
+
+    type: Required[Literal["categorical", "free_text", "rating", "number"]]
+
+    choices: Iterable[Choice]
+
+    conditions: Iterable[Dict[str, object]]
+
+    dropdown: bool
+
+    multi: bool
+
+    number_options: Annotated[NumberOptions, PropertyInfo(alias="numberOptions")]
+
+    rating_options: Annotated[RatingOptions, PropertyInfo(alias="ratingOptions")]
+
+    required: bool
+
+
+class Choice(TypedDict, total=False):
+    label: Required[str]
+
+    value: Required[Union[str, bool, float]]
+
+    audit_required: bool
+
+
+class NumberOptions(TypedDict, total=False):
+    max: float
+    """Maximum value for the number"""
+
+    min: float
+    """Minimum value for the number"""
+
+
+class RatingOptions(TypedDict, total=False):
+    max_label: Required[Annotated[str, PropertyInfo(alias="maxLabel")]]
+    """Maximum value for the rating"""
+
+    min_label: Required[Annotated[str, PropertyInfo(alias="minLabel")]]
+    """Minimum value for the rating"""
+
+    scale_steps: Required[Annotated[int, PropertyInfo(alias="scaleSteps")]]
+    """Number of steps in the rating scale"""

scale_gp/types/question_list.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .question import Question
+
+__all__ = ["QuestionList"]
+
+
+class QuestionList(BaseModel):
+    has_more: bool
+    """Whether there are more items left to be fetched."""
+
+    items: List[Question]
+
+    total: int
+    """The total of items that match the query.
+
+    This is greater than or equal to the number of items returned.
+    """
+
+    limit: Optional[int] = None
+    """The maximum number of items to return."""
+
+    object: Optional[Literal["list"]] = None

scale_gp/types/question_list_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["QuestionListParams"]
+
+
+class QuestionListParams(TypedDict, total=False):
+    ending_before: Optional[str]
+
+    limit: int
+
+    starting_after: Optional[str]

scale_gp/types/question_set.py

@@ -0,0 +1,106 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = [
+    "QuestionSet",
+    "Question",
+    "QuestionChoice",
+    "QuestionNumberOptions",
+    "QuestionOverrideConfig",
+    "QuestionRatingOptions",
+]
+
+
+class QuestionChoice(BaseModel):
+    label: str
+
+    value: Union[str, bool, float]
+
+    audit_required: Optional[bool] = None
+
+
+class QuestionNumberOptions(BaseModel):
+    max: Optional[float] = None
+    """Maximum value for the number"""
+
+    min: Optional[float] = None
+    """Minimum value for the number"""
+
+
+class QuestionOverrideConfig(BaseModel):
+    required: Optional[bool] = None
+    """Whether the question is required. False by default."""
+
+
+class QuestionRatingOptions(BaseModel):
+    max_label: str = FieldInfo(alias="maxLabel")
+    """Maximum value for the rating"""
+
+    min_label: str = FieldInfo(alias="minLabel")
+    """Minimum value for the rating"""
+
+    scale_steps: int = FieldInfo(alias="scaleSteps")
+    """Number of steps in the rating scale"""
+
+
+class Question(BaseModel):
+    id: str
+
+    created_at: datetime
+
+    created_by_user_id: str
+
+    prompt: str
+
+    title: str
+
+    type: Literal["categorical", "free_text", "rating", "number"]
+
+    choices: Optional[List[QuestionChoice]] = None
+
+    conditions: Optional[List[Dict[str, object]]] = None
+
+    dropdown: Optional[bool] = None
+
+    multi: Optional[bool] = None
+
+    number_options: Optional[QuestionNumberOptions] = FieldInfo(alias="numberOptions", default=None)
+
+    object: Optional[Literal["question"]] = None
+
+    override_config: Optional[QuestionOverrideConfig] = None
+    """
+    Specifies additional configurations to use for the question in the context of
+    the question set. For example, `{required: true}` sets the question as required.
+    Writes to the question_id_to_config field on the response
+    """
+
+    rating_options: Optional[QuestionRatingOptions] = FieldInfo(alias="ratingOptions", default=None)
+
+    required: Optional[bool] = None
+
+
+class QuestionSet(BaseModel):
+    id: str
+
+    created_at: datetime
+
+    created_by_user_id: str
+
+    name: str
+
+    archived_at: Optional[datetime] = None
+
+    instructions: Optional[str] = None
+
+    object: Optional[Literal["question_set"]] = None
+
+    questions: Optional[List[Question]] = None
+    """Questions in the question set"""

scale_gp/types/question_set_create_params.py

@@ -0,0 +1,115 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Union, Iterable
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = [
+    "QuestionSetCreateParams",
+    "Question",
+    "QuestionQuestionCreateRequestWithConfig",
+    "QuestionQuestionCreateRequestWithConfigChoice",
+    "QuestionQuestionCreateRequestWithConfigNumberOptions",
+    "QuestionQuestionCreateRequestWithConfigOverrideConfig",
+    "QuestionQuestionCreateRequestWithConfigRatingOptions",
+    "QuestionQuestionIDWithConfiguration",
+    "QuestionQuestionIDWithConfigurationOverrideConfig",
+]
+
+
+class QuestionSetCreateParams(TypedDict, total=False):
+    name: Required[str]
+
+    questions: Required[List[Question]]
+    """IDs of existing questions in the question set or new questions to create.
+
+    You can also optionally specify configurations for each question. Example:
+    [`question_id`, {'id': 'question_id2', 'configuration': {...}}, {'title': 'New
+    question', ...}]
+    """
+
+    instructions: str
+    """Instructions to answer questions"""
+
+
+class QuestionQuestionCreateRequestWithConfigChoice(TypedDict, total=False):
+    label: Required[str]
+
+    value: Required[Union[str, bool, float]]
+
+    audit_required: bool
+
+
+class QuestionQuestionCreateRequestWithConfigNumberOptions(TypedDict, total=False):
+    max: float
+    """Maximum value for the number"""
+
+    min: float
+    """Minimum value for the number"""
+
+
+class QuestionQuestionCreateRequestWithConfigOverrideConfig(TypedDict, total=False):
+    required: bool
+    """Whether the question is required. False by default."""
+
+
+class QuestionQuestionCreateRequestWithConfigRatingOptions(TypedDict, total=False):
+    max_label: Required[Annotated[str, PropertyInfo(alias="maxLabel")]]
+    """Maximum value for the rating"""
+
+    min_label: Required[Annotated[str, PropertyInfo(alias="minLabel")]]
+    """Minimum value for the rating"""
+
+    scale_steps: Required[Annotated[int, PropertyInfo(alias="scaleSteps")]]
+    """Number of steps in the rating scale"""
+
+
+class QuestionQuestionCreateRequestWithConfig(TypedDict, total=False):
+    prompt: Required[str]
+
+    title: Required[str]
+
+    type: Required[Literal["categorical", "free_text", "rating", "number"]]
+
+    choices: Iterable[QuestionQuestionCreateRequestWithConfigChoice]
+
+    conditions: Iterable[Dict[str, object]]
+
+    dropdown: bool
+
+    multi: bool
+
+    number_options: Annotated[QuestionQuestionCreateRequestWithConfigNumberOptions, PropertyInfo(alias="numberOptions")]
+
+    override_config: QuestionQuestionCreateRequestWithConfigOverrideConfig
+    """
+    Specifies additional configurations to use for the question in the context of
+    the question set. For example, `{required: true}` sets the question as required.
+    Writes to the question_id_to_config field on the response
+    """
+
+    rating_options: Annotated[QuestionQuestionCreateRequestWithConfigRatingOptions, PropertyInfo(alias="ratingOptions")]
+
+    required: bool
+
+
+class QuestionQuestionIDWithConfigurationOverrideConfig(TypedDict, total=False):
+    required: bool
+    """Whether the question is required. False by default."""
+
+
+class QuestionQuestionIDWithConfiguration(TypedDict, total=False):
+    id: Required[str]
+
+    override_config: QuestionQuestionIDWithConfigurationOverrideConfig
+    """
+    Specifies additional configurations to use for the question in the context of
+    the question set. For example, `{required: true}` sets the question as required.
+    Writes to the question_id_to_config field on the response
+    """
+
+
+Question: TypeAlias = Union[QuestionQuestionCreateRequestWithConfig, QuestionQuestionIDWithConfiguration, str]

scale_gp/types/question_set_delete_response.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["QuestionSetDeleteResponse"]
+
+
+class QuestionSetDeleteResponse(BaseModel):
+    id: str
+
+    deleted: bool
+
+    object: Optional[Literal["question_set"]] = None

scale_gp/types/question_set_list.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .question_set import QuestionSet
+
+__all__ = ["QuestionSetList"]
+
+
+class QuestionSetList(BaseModel):
+    has_more: bool
+    """Whether there are more items left to be fetched."""
+
+    items: List[QuestionSet]
+
+    total: int
+    """The total of items that match the query.
+
+    This is greater than or equal to the number of items returned.
+    """
+
+    limit: Optional[int] = None
+    """The maximum number of items to return."""
+
+    object: Optional[Literal["list"]] = None

scale_gp/types/question_set_list_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["QuestionSetListParams"]
+
+
+class QuestionSetListParams(TypedDict, total=False):
+    ending_before: Optional[str]
+
+    include_archived: bool
+
+    limit: int
+
+    starting_after: Optional[str]
+
+    views: List[Literal["questions"]]

scale_gp/types/question_set_retrieve_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["QuestionSetRetrieveParams"]
+
+
+class QuestionSetRetrieveParams(TypedDict, total=False):
+    views: List[Literal["questions"]]

scale_gp/types/question_set_update_params.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+__all__ = ["QuestionSetUpdateParams", "PartialQuestionSetRequestBase", "RestoreRequest"]
+
+
+class PartialQuestionSetRequestBase(TypedDict, total=False):
+    instructions: str
+    """Instructions to answer questions"""
+
+    name: str
+
+
+class RestoreRequest(TypedDict, total=False):
+    restore: Required[Literal[True]]
+    """Set to true to restore the entity from the database."""
+
+
+QuestionSetUpdateParams: TypeAlias = Union[PartialQuestionSetRequestBase, RestoreRequest]