@vendasta/forms_microservice 0.15.0 → 0.17.0

package/lib/_internal/enums/api.enum.d.ts

@@ -11,9 +11,18 @@ export declare enum FieldType {
     FIELD_TYPE_EMAIL = 9,
     FIELD_TYPE_PHONE = 10,
     FIELD_TYPE_BUSINESS_SEARCH = 11,
-    FIELD_TYPE_TEXT_AREA = 12
+    FIELD_TYPE_TEXT_AREA = 12,
+    FIELD_TYPE_TAG = 13,
+    FIELD_TYPE_SECTION = 14
 }
 export declare enum JsonSchemaLibrary {
     JSON_SCHEMA_LIBRARY_UNDEFINED = 0,
     JSON_SCHEMA_LIBRARY_JSONFORM = 1
 }
+export declare enum SectionAction {
+    SECTION_ACTION_UNDEFINED = 0,
+    SECTION_ACTION_SUBMIT = 1,
+    SECTION_ACTION_SUBMIT_CONDITION = 2,
+    SECTION_ACTION_NEXT_PAGE = 3,
+    SECTION_ACTION_NEXT_APPEND = 4
+}

package/lib/_internal/enums/index.d.ts

@@ -1 +1 @@
-export { FieldType, JsonSchemaLibrary, } from './api.enum';
+export { FieldType, JsonSchemaLibrary, SectionAction, } from './api.enum';

package/lib/_internal/interfaces/api.interface.d.ts

@@ -1,5 +1,9 @@
 import { PagedRequestOptionsInterface, PagedResponseMetadataInterface } from './paging.interface';
 import * as e from '../enums';
+export interface ActionParametersInterface {
+    submitConditionParams?: SubmitConditionParametersInterface;
+    nextParameters?: NextParametersInterface;
+}
 export interface CreateFormRequestInterface {
     formConfig?: FormConfigInterface;
 }
@@ -15,6 +19,10 @@ export interface CreateFormSubmissionRequestInterface {
 export interface CreateFormSubmissionResponseInterface {
     redirectUrl?: string;
 }
+export interface RenderFormResponseDefaultValuesInterface {
+    fieldId?: string;
+    jsonValue?: string;
+}
 export interface DeleteFormRequestInterface {
     formId?: string;
     version?: string;
@@ -28,6 +36,7 @@ export interface FormConfigFieldInterface {
     preFillByUrlQueryParameter?: string;
     placeholder?: string;
     defaultPhoneIsoCountryCode?: string;
+    sectionConfig?: SectionConfigInterface;
 }
 export interface FieldOptionInterface {
     value?: string;
@@ -37,6 +46,7 @@ export interface FieldValueInterface {
     invalid?: boolean;
     integer?: number;
     string?: string;
+    stringValues?: StringListInterface;
     boolean?: boolean;
 }
 export interface ListFormsRequestFiltersInterface {
@@ -139,6 +149,9 @@ export interface MappedFieldInterface {
     systemDefined?: SystemDefinedInterface;
     readonly?: boolean;
 }
+export interface NextParametersInterface {
+    nextSectionId?: string;
+}
 export interface RenderFormResponsePreFillByUrlQueryParameterInterface {
     fieldId?: string;
     queryParam?: string;
@@ -161,11 +174,20 @@ export interface RenderFormResponseInterface {
     styles?: StylesInterface;
     fieldQueryParams?: RenderFormResponsePreFillByUrlQueryParameterInterface[];
     recaptchaSiteKey?: string;
+    defaultValues?: RenderFormResponseDefaultValuesInterface[];
 }
 export interface FormConfigFieldSchemaInterface {
     unmappedField?: UnmappedFieldInterface;
     mappedField?: MappedFieldInterface;
 }
+export interface SectionConfigInterface {
+    buttonLabel?: string;
+    buttonAction?: e.SectionAction;
+    actionParameters?: ActionParametersInterface;
+}
+export interface StringListInterface {
+    values?: string[];
+}
 export interface StylesInterface {
     width?: string;
     backgroundColor?: string;
@@ -178,6 +200,15 @@ export interface StylesInterface {
     primaryColor?: string;
     onPrimaryColor?: string;
 }
+export interface SubmitConditionParametersInterface {
+    fieldId?: string;
+    noValue?: boolean;
+    anyValue?: boolean;
+    isValue?: string;
+    isNotValue?: string;
+    onConditionFailure?: e.SectionAction;
+    onConditionFailureParameters?: ActionParametersInterface;
+}
 export interface FormSubmissionSubmittedValueInterface {
     fieldId?: string;
     fieldValue?: FieldValueInterface;

package/lib/_internal/interfaces/index.d.ts

@@ -1,2 +1,2 @@
 export { PagedRequestOptionsInterface, PagedResponseMetadataInterface, } from './paging.interface';
-export { CreateFormRequestInterface, CreateFormResponseInterface, CreateFormSubmissionRequestInterface, CreateFormSubmissionResponseInterface, DeleteFormRequestInterface, FormConfigFieldInterface, FieldOptionInterface, FieldValueInterface, ListFormsRequestFiltersInterface, FormConfigInterface, GetMultiRequestFormConfigIdentifierInterface, ListFormsResponseFormRowInterface, FormSubmissionInterface, GetEmbedCodeRequestInterface, GetEmbedCodeResponseInterface, GetFormRequestInterface, GetFormResponseInterface, GetMultiFormSubmissionRequestInterface, GetMultiFormSubmissionResponseInterface, GetMultiFormVersionsListRequestInterface, GetMultiFormVersionsListResponseInterface, GetMultiRequestInterface, GetMultiResponseInterface, ListFormSubmissionRequestInterface, ListFormSubmissionResponseInterface, ListFormsRequestInterface, ListFormsResponseInterface, ListMappedFieldSchemaRequestInterface, ListMappedFieldSchemaResponseInterface, MappedFieldInterface, RenderFormResponsePreFillByUrlQueryParameterInterface, PreviewFormRequestInterface, PreviewFormResponseInterface, RenderFormRequestInterface, RenderFormResponseInterface, FormConfigFieldSchemaInterface, StylesInterface, FormSubmissionSubmittedValueInterface, SystemDefinedInterface, UnmappedFieldInterface, UpdateFormRequestInterface, UpdateFormResponseInterface, UserFormSubmissionInterface, ValidationErrorInterface, GetMultiFormVersionsListResponseVersionsInterface, } from './api.interface';
+export { ActionParametersInterface, CreateFormRequestInterface, CreateFormResponseInterface, CreateFormSubmissionRequestInterface, CreateFormSubmissionResponseInterface, RenderFormResponseDefaultValuesInterface, DeleteFormRequestInterface, FormConfigFieldInterface, FieldOptionInterface, FieldValueInterface, ListFormsRequestFiltersInterface, FormConfigInterface, GetMultiRequestFormConfigIdentifierInterface, ListFormsResponseFormRowInterface, FormSubmissionInterface, GetEmbedCodeRequestInterface, GetEmbedCodeResponseInterface, GetFormRequestInterface, GetFormResponseInterface, GetMultiFormSubmissionRequestInterface, GetMultiFormSubmissionResponseInterface, GetMultiFormVersionsListRequestInterface, GetMultiFormVersionsListResponseInterface, GetMultiRequestInterface, GetMultiResponseInterface, ListFormSubmissionRequestInterface, ListFormSubmissionResponseInterface, ListFormsRequestInterface, ListFormsResponseInterface, ListMappedFieldSchemaRequestInterface, ListMappedFieldSchemaResponseInterface, MappedFieldInterface, NextParametersInterface, RenderFormResponsePreFillByUrlQueryParameterInterface, PreviewFormRequestInterface, PreviewFormResponseInterface, RenderFormRequestInterface, RenderFormResponseInterface, FormConfigFieldSchemaInterface, SectionConfigInterface, StringListInterface, StylesInterface, SubmitConditionParametersInterface, FormSubmissionSubmittedValueInterface, SystemDefinedInterface, UnmappedFieldInterface, UpdateFormRequestInterface, UpdateFormResponseInterface, UserFormSubmissionInterface, ValidationErrorInterface, GetMultiFormVersionsListResponseVersionsInterface, } from './api.interface';

package/lib/_internal/objects/api.d.ts

@@ -2,6 +2,13 @@ import * as i from '../interfaces';
 import { PagedRequestOptions, PagedResponseMetadata } from './paging';
 import * as e from '../enums';
 export declare function enumStringToValue<E>(enumRef: any, value: string): E;
+export declare class ActionParameters implements i.ActionParametersInterface {
+    submitConditionParams: SubmitConditionParameters;
+    nextParameters: NextParameters;
+    static fromProto(proto: any): ActionParameters;
+    constructor(kwargs?: i.ActionParametersInterface);
+    toApiJson(): object;
+}
 export declare class CreateFormRequest implements i.CreateFormRequestInterface {
     formConfig: FormConfig;
     static fromProto(proto: any): CreateFormRequest;
@@ -29,6 +36,13 @@ export declare class CreateFormSubmissionResponse implements i.CreateFormSubmiss
     constructor(kwargs?: i.CreateFormSubmissionResponseInterface);
     toApiJson(): object;
 }
+export declare class RenderFormResponseDefaultValues implements i.RenderFormResponseDefaultValuesInterface {
+    fieldId: string;
+    jsonValue: string;
+    static fromProto(proto: any): RenderFormResponseDefaultValues;
+    constructor(kwargs?: i.RenderFormResponseDefaultValuesInterface);
+    toApiJson(): object;
+}
 export declare class DeleteFormRequest implements i.DeleteFormRequestInterface {
     formId: string;
     version: string;
@@ -45,6 +59,7 @@ export declare class FormConfigField implements i.FormConfigFieldInterface {
     preFillByUrlQueryParameter: string;
     placeholder: string;
     defaultPhoneIsoCountryCode: string;
+    sectionConfig: SectionConfig;
     static fromProto(proto: any): FormConfigField;
     constructor(kwargs?: i.FormConfigFieldInterface);
     toApiJson(): object;
@@ -60,6 +75,7 @@ export declare class FieldValue implements i.FieldValueInterface {
     invalid: boolean;
     integer: number;
     string: string;
+    stringValues: StringList;
     boolean: boolean;
     static fromProto(proto: any): FieldValue;
     constructor(kwargs?: i.FieldValueInterface);
@@ -231,6 +247,12 @@ export declare class MappedField implements i.MappedFieldInterface {
     constructor(kwargs?: i.MappedFieldInterface);
     toApiJson(): object;
 }
+export declare class NextParameters implements i.NextParametersInterface {
+    nextSectionId: string;
+    static fromProto(proto: any): NextParameters;
+    constructor(kwargs?: i.NextParametersInterface);
+    toApiJson(): object;
+}
 export declare class RenderFormResponsePreFillByUrlQueryParameter implements i.RenderFormResponsePreFillByUrlQueryParameterInterface {
     fieldId: string;
     queryParam: string;
@@ -265,6 +287,7 @@ export declare class RenderFormResponse implements i.RenderFormResponseInterface
     styles: Styles;
     fieldQueryParams: RenderFormResponsePreFillByUrlQueryParameter[];
     recaptchaSiteKey: string;
+    defaultValues: RenderFormResponseDefaultValues[];
     static fromProto(proto: any): RenderFormResponse;
     constructor(kwargs?: i.RenderFormResponseInterface);
     toApiJson(): object;
@@ -276,6 +299,20 @@ export declare class FormConfigFieldSchema implements i.FormConfigFieldSchemaInt
     constructor(kwargs?: i.FormConfigFieldSchemaInterface);
     toApiJson(): object;
 }
+export declare class SectionConfig implements i.SectionConfigInterface {
+    buttonLabel: string;
+    buttonAction: e.SectionAction;
+    actionParameters: ActionParameters;
+    static fromProto(proto: any): SectionConfig;
+    constructor(kwargs?: i.SectionConfigInterface);
+    toApiJson(): object;
+}
+export declare class StringList implements i.StringListInterface {
+    values: string[];
+    static fromProto(proto: any): StringList;
+    constructor(kwargs?: i.StringListInterface);
+    toApiJson(): object;
+}
 export declare class Styles implements i.StylesInterface {
     width: string;
     backgroundColor: string;
@@ -291,6 +328,18 @@ export declare class Styles implements i.StylesInterface {
     constructor(kwargs?: i.StylesInterface);
     toApiJson(): object;
 }
+export declare class SubmitConditionParameters implements i.SubmitConditionParametersInterface {
+    fieldId: string;
+    noValue: boolean;
+    anyValue: boolean;
+    isValue: string;
+    isNotValue: string;
+    onConditionFailure: e.SectionAction;
+    onConditionFailureParameters: ActionParameters;
+    static fromProto(proto: any): SubmitConditionParameters;
+    constructor(kwargs?: i.SubmitConditionParametersInterface);
+    toApiJson(): object;
+}
 export declare class FormSubmissionSubmittedValue implements i.FormSubmissionSubmittedValueInterface {
     fieldId: string;
     fieldValue: FieldValue;

package/lib/_internal/objects/index.d.ts

@@ -1,2 +1,2 @@
 export { PagedRequestOptions, PagedResponseMetadata, } from './paging';
-export { CreateFormRequest, CreateFormResponse, CreateFormSubmissionRequest, CreateFormSubmissionResponse, DeleteFormRequest, FormConfigField, FieldOption, FieldValue, ListFormsRequestFilters, FormConfig, GetMultiRequestFormConfigIdentifier, ListFormsResponseFormRow, FormSubmission, GetEmbedCodeRequest, GetEmbedCodeResponse, GetFormRequest, GetFormResponse, GetMultiFormSubmissionRequest, GetMultiFormSubmissionResponse, GetMultiFormVersionsListRequest, GetMultiFormVersionsListResponse, GetMultiRequest, GetMultiResponse, ListFormSubmissionRequest, ListFormSubmissionResponse, ListFormsRequest, ListFormsResponse, ListMappedFieldSchemaRequest, ListMappedFieldSchemaResponse, MappedField, RenderFormResponsePreFillByUrlQueryParameter, PreviewFormRequest, PreviewFormResponse, RenderFormRequest, RenderFormResponse, FormConfigFieldSchema, Styles, FormSubmissionSubmittedValue, SystemDefined, UnmappedField, UpdateFormRequest, UpdateFormResponse, UserFormSubmission, ValidationError, GetMultiFormVersionsListResponseVersions, } from './api';
+export { ActionParameters, CreateFormRequest, CreateFormResponse, CreateFormSubmissionRequest, CreateFormSubmissionResponse, RenderFormResponseDefaultValues, DeleteFormRequest, FormConfigField, FieldOption, FieldValue, ListFormsRequestFilters, FormConfig, GetMultiRequestFormConfigIdentifier, ListFormsResponseFormRow, FormSubmission, GetEmbedCodeRequest, GetEmbedCodeResponse, GetFormRequest, GetFormResponse, GetMultiFormSubmissionRequest, GetMultiFormSubmissionResponse, GetMultiFormVersionsListRequest, GetMultiFormVersionsListResponse, GetMultiRequest, GetMultiResponse, ListFormSubmissionRequest, ListFormSubmissionResponse, ListFormsRequest, ListFormsResponse, ListMappedFieldSchemaRequest, ListMappedFieldSchemaResponse, MappedField, NextParameters, RenderFormResponsePreFillByUrlQueryParameter, PreviewFormRequest, PreviewFormResponse, RenderFormRequest, RenderFormResponse, FormConfigFieldSchema, SectionConfig, StringList, Styles, SubmitConditionParameters, FormSubmissionSubmittedValue, SystemDefined, UnmappedField, UpdateFormRequest, UpdateFormResponse, UserFormSubmission, ValidationError, GetMultiFormVersionsListResponseVersions, } from './api';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vendasta/forms_microservice",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "peerDependencies": {
     "@angular/common": "^15.1.0",
     "@angular/core": "^15.1.0"