@wix/papyrus 1.0.12 → 1.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -144,14 +144,14 @@ interface DeleteDocumentResponse$1 {
144
144
  }
145
145
  interface QueryDocumentRequest$1 {
146
146
  /** WQL expression */
147
- query: QueryV2$1;
147
+ query: QueryV2$3;
148
148
  fields?: RequestedFields$1[];
149
149
  }
150
- interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
150
+ interface QueryV2$3 extends QueryV2PagingMethodOneOf$3 {
151
151
  /** Paging options to limit and skip the number of items. */
152
- paging?: Paging$1;
152
+ paging?: Paging$3;
153
153
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
154
- cursorPaging?: CursorPaging$1;
154
+ cursorPaging?: CursorPaging$3;
155
155
  /**
156
156
  * Filter object.
157
157
  *
@@ -163,36 +163,36 @@ interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
163
163
  *
164
164
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
165
165
  */
166
- sort?: Sorting$1[];
166
+ sort?: Sorting$3[];
167
167
  /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
168
168
  fields?: string[];
169
169
  /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
170
170
  fieldsets?: string[];
171
171
  }
172
172
  /** @oneof */
173
- interface QueryV2PagingMethodOneOf$1 {
173
+ interface QueryV2PagingMethodOneOf$3 {
174
174
  /** Paging options to limit and skip the number of items. */
175
- paging?: Paging$1;
175
+ paging?: Paging$3;
176
176
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
177
- cursorPaging?: CursorPaging$1;
177
+ cursorPaging?: CursorPaging$3;
178
178
  }
179
- interface Sorting$1 {
179
+ interface Sorting$3 {
180
180
  /** Name of the field to sort by. */
181
181
  fieldName?: string;
182
182
  /** Sort order. */
183
- order?: SortOrder$1;
183
+ order?: SortOrder$3;
184
184
  }
185
- declare enum SortOrder$1 {
185
+ declare enum SortOrder$3 {
186
186
  ASC = "ASC",
187
187
  DESC = "DESC"
188
188
  }
189
- interface Paging$1 {
189
+ interface Paging$3 {
190
190
  /** Number of items to load. */
191
191
  limit?: number | null;
192
192
  /** Number of items to skip in the current sort order. */
193
193
  offset?: number | null;
194
194
  }
195
- interface CursorPaging$1 {
195
+ interface CursorPaging$3 {
196
196
  /** Maximum number of items to return in the results. */
197
197
  limit?: number | null;
198
198
  /**
@@ -207,9 +207,9 @@ interface QueryDocumentResponse$1 {
207
207
  /** The retrieved Documents */
208
208
  documents?: Document$1[];
209
209
  /** Query results' metadata */
210
- metadata?: PagingMetadataV2$1;
210
+ metadata?: PagingMetadataV2$3;
211
211
  }
212
- interface PagingMetadataV2$1 {
212
+ interface PagingMetadataV2$3 {
213
213
  /** Number of items returned in the response. */
214
214
  count?: number | null;
215
215
  /** Offset that was requested. */
@@ -219,9 +219,9 @@ interface PagingMetadataV2$1 {
219
219
  /** Flag that indicates the server failed to calculate the `total` field. */
220
220
  tooManyToCount?: boolean | null;
221
221
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
222
- cursors?: Cursors$1;
222
+ cursors?: Cursors$3;
223
223
  }
224
- interface Cursors$1 {
224
+ interface Cursors$3 {
225
225
  /** Cursor string pointing to the next page in the list of results. */
226
226
  next?: string | null;
227
227
  /** Cursor pointing to the previous page in the list of results. */
@@ -504,14 +504,14 @@ interface DeleteDocumentResponse {
504
504
  }
505
505
  interface QueryDocumentRequest {
506
506
  /** WQL expression */
507
- query: QueryV2;
507
+ query: QueryV2$2;
508
508
  fields?: RequestedFields[];
509
509
  }
510
- interface QueryV2 extends QueryV2PagingMethodOneOf {
510
+ interface QueryV2$2 extends QueryV2PagingMethodOneOf$2 {
511
511
  /** Paging options to limit and skip the number of items. */
512
- paging?: Paging;
512
+ paging?: Paging$2;
513
513
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
514
- cursorPaging?: CursorPaging;
514
+ cursorPaging?: CursorPaging$2;
515
515
  /**
516
516
  * Filter object.
517
517
  *
@@ -523,36 +523,36 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
523
523
  *
524
524
  * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
525
525
  */
526
- sort?: Sorting[];
526
+ sort?: Sorting$2[];
527
527
  /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
528
528
  fields?: string[];
529
529
  /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
530
530
  fieldsets?: string[];
531
531
  }
532
532
  /** @oneof */
533
- interface QueryV2PagingMethodOneOf {
533
+ interface QueryV2PagingMethodOneOf$2 {
534
534
  /** Paging options to limit and skip the number of items. */
535
- paging?: Paging;
535
+ paging?: Paging$2;
536
536
  /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
537
- cursorPaging?: CursorPaging;
537
+ cursorPaging?: CursorPaging$2;
538
538
  }
539
- interface Sorting {
539
+ interface Sorting$2 {
540
540
  /** Name of the field to sort by. */
541
541
  fieldName?: string;
542
542
  /** Sort order. */
543
- order?: SortOrder;
543
+ order?: SortOrder$2;
544
544
  }
545
- declare enum SortOrder {
545
+ declare enum SortOrder$2 {
546
546
  ASC = "ASC",
547
547
  DESC = "DESC"
548
548
  }
549
- interface Paging {
549
+ interface Paging$2 {
550
550
  /** Number of items to load. */
551
551
  limit?: number | null;
552
552
  /** Number of items to skip in the current sort order. */
553
553
  offset?: number | null;
554
554
  }
555
- interface CursorPaging {
555
+ interface CursorPaging$2 {
556
556
  /** Maximum number of items to return in the results. */
557
557
  limit?: number | null;
558
558
  /**
@@ -567,9 +567,9 @@ interface QueryDocumentResponse {
567
567
  /** The retrieved Documents */
568
568
  documents?: Document[];
569
569
  /** Query results' metadata */
570
- metadata?: PagingMetadataV2;
570
+ metadata?: PagingMetadataV2$2;
571
571
  }
572
- interface PagingMetadataV2 {
572
+ interface PagingMetadataV2$2 {
573
573
  /** Number of items returned in the response. */
574
574
  count?: number | null;
575
575
  /** Offset that was requested. */
@@ -579,9 +579,9 @@ interface PagingMetadataV2 {
579
579
  /** Flag that indicates the server failed to calculate the `total` field. */
580
580
  tooManyToCount?: boolean | null;
581
581
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
582
- cursors?: Cursors;
582
+ cursors?: Cursors$2;
583
583
  }
584
- interface Cursors {
584
+ interface Cursors$2 {
585
585
  /** Cursor string pointing to the next page in the list of results. */
586
586
  next?: string | null;
587
587
  /** Cursor pointing to the previous page in the list of results. */
@@ -718,7 +718,7 @@ interface DownloadDocumentSourceResponseNonNullableFields {
718
718
  downloadUrl: string;
719
719
  }
720
720
 
721
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
721
+ type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
722
722
  getUrl: (context: any) => string;
723
723
  httpMethod: K;
724
724
  path: string;
@@ -728,27 +728,26 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
728
728
  __responseType: Q;
729
729
  __originalResponseType: R;
730
730
  };
731
- declare function getDownloadPage(): __PublicMethodMetaInfo<'GET', {}, GetDownloadPageRequest, GetDownloadPageRequest$1, RawHttpResponse & RawHttpResponseNonNullableFields, RawHttpResponse$1 & RawHttpResponseNonNullableFields$1>;
732
- declare function createDocument(): __PublicMethodMetaInfo<'POST', {}, CreateDocumentRequest, CreateDocumentRequest$1, CreateDocumentResponse & CreateDocumentResponseNonNullableFields, CreateDocumentResponse$1 & CreateDocumentResponseNonNullableFields$1>;
733
- declare function getDocument(): __PublicMethodMetaInfo<'GET', {
731
+ declare function getDownloadPage(): __PublicMethodMetaInfo$1<'GET', {}, GetDownloadPageRequest, GetDownloadPageRequest$1, RawHttpResponse & RawHttpResponseNonNullableFields, RawHttpResponse$1 & RawHttpResponseNonNullableFields$1>;
732
+ declare function createDocument(): __PublicMethodMetaInfo$1<'POST', {}, CreateDocumentRequest, CreateDocumentRequest$1, CreateDocumentResponse & CreateDocumentResponseNonNullableFields, CreateDocumentResponse$1 & CreateDocumentResponseNonNullableFields$1>;
733
+ declare function getDocument(): __PublicMethodMetaInfo$1<'GET', {
734
734
  documentId: string;
735
735
  }, GetDocumentRequest, GetDocumentRequest$1, GetDocumentResponse & GetDocumentResponseNonNullableFields, GetDocumentResponse$1 & GetDocumentResponseNonNullableFields$1>;
736
- declare function deleteDocument(): __PublicMethodMetaInfo<'DELETE', {
736
+ declare function deleteDocument(): __PublicMethodMetaInfo$1<'DELETE', {
737
737
  documentId: string;
738
738
  }, DeleteDocumentRequest, DeleteDocumentRequest$1, DeleteDocumentResponse & DeleteDocumentResponseNonNullableFields, DeleteDocumentResponse$1 & DeleteDocumentResponseNonNullableFields$1>;
739
- declare function queryDocument(): __PublicMethodMetaInfo<'POST', {}, QueryDocumentRequest, QueryDocumentRequest$1, QueryDocumentResponse & QueryDocumentResponseNonNullableFields, QueryDocumentResponse$1 & QueryDocumentResponseNonNullableFields$1>;
740
- declare function updateDocument(): __PublicMethodMetaInfo<'PATCH', {
739
+ declare function queryDocument(): __PublicMethodMetaInfo$1<'POST', {}, QueryDocumentRequest, QueryDocumentRequest$1, QueryDocumentResponse & QueryDocumentResponseNonNullableFields, QueryDocumentResponse$1 & QueryDocumentResponseNonNullableFields$1>;
740
+ declare function updateDocument(): __PublicMethodMetaInfo$1<'PATCH', {
741
741
  id: string;
742
742
  }, UpdateDocumentRequest, UpdateDocumentRequest$1, UpdateDocumentResponse & UpdateDocumentResponseNonNullableFields, UpdateDocumentResponse$1 & UpdateDocumentResponseNonNullableFields$1>;
743
- declare function downloadDocument(): __PublicMethodMetaInfo<'GET', {
743
+ declare function downloadDocument(): __PublicMethodMetaInfo$1<'GET', {
744
744
  documentId: string;
745
745
  }, DownloadDocumentRequest, DownloadDocumentRequest$1, DownloadDocumentResponse & DownloadDocumentResponseNonNullableFields, DownloadDocumentResponse$1 & DownloadDocumentResponseNonNullableFields$1>;
746
- declare function getDownloadUrl(): __PublicMethodMetaInfo<'GET', {}, GetDownloadUrlRequest, GetDownloadUrlRequest$1, GetDownloadUrlResponse & GetDownloadUrlResponseNonNullableFields, GetDownloadUrlResponse$1 & GetDownloadUrlResponseNonNullableFields$1>;
747
- declare function downloadDocumentSource(): __PublicMethodMetaInfo<'GET', {
746
+ declare function getDownloadUrl(): __PublicMethodMetaInfo$1<'GET', {}, GetDownloadUrlRequest, GetDownloadUrlRequest$1, GetDownloadUrlResponse & GetDownloadUrlResponseNonNullableFields, GetDownloadUrlResponse$1 & GetDownloadUrlResponseNonNullableFields$1>;
747
+ declare function downloadDocumentSource(): __PublicMethodMetaInfo$1<'GET', {
748
748
  documentId: string;
749
749
  }, DownloadDocumentSourceRequest, DownloadDocumentSourceRequest$1, DownloadDocumentSourceResponse & DownloadDocumentSourceResponseNonNullableFields, DownloadDocumentSourceResponse$1 & DownloadDocumentSourceResponseNonNullableFields$1>;
750
750
 
751
- type meta_d___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
752
751
  declare const meta_d_createDocument: typeof createDocument;
753
752
  declare const meta_d_deleteDocument: typeof deleteDocument;
754
753
  declare const meta_d_downloadDocument: typeof downloadDocument;
@@ -759,7 +758,1278 @@ declare const meta_d_getDownloadUrl: typeof getDownloadUrl;
759
758
  declare const meta_d_queryDocument: typeof queryDocument;
760
759
  declare const meta_d_updateDocument: typeof updateDocument;
761
760
  declare namespace meta_d {
762
- export { type meta_d___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_d_createDocument as createDocument, meta_d_deleteDocument as deleteDocument, meta_d_downloadDocument as downloadDocument, meta_d_downloadDocumentSource as downloadDocumentSource, meta_d_getDocument as getDocument, meta_d_getDownloadPage as getDownloadPage, meta_d_getDownloadUrl as getDownloadUrl, meta_d_queryDocument as queryDocument, meta_d_updateDocument as updateDocument };
761
+ export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta_d_createDocument as createDocument, meta_d_deleteDocument as deleteDocument, meta_d_downloadDocument as downloadDocument, meta_d_downloadDocumentSource as downloadDocumentSource, meta_d_getDocument as getDocument, meta_d_getDownloadPage as getDownloadPage, meta_d_getDownloadUrl as getDownloadUrl, meta_d_queryDocument as queryDocument, meta_d_updateDocument as updateDocument };
762
+ }
763
+
764
+ interface TemplateSettings$1 {
765
+ /**
766
+ * Auto generated ID.
767
+ * @format GUID
768
+ * @readonly
769
+ */
770
+ id?: string | null;
771
+ /**
772
+ * Wix app definition ID.
773
+ * @minLength 1
774
+ * @maxLength 20
775
+ */
776
+ appSlug?: string | null;
777
+ /**
778
+ * The type of the template.
779
+ * @minLength 1
780
+ * @maxLength 20
781
+ */
782
+ templateType?: string | null;
783
+ /**
784
+ * The id of the template.
785
+ * @minLength 1
786
+ * @maxLength 20
787
+ */
788
+ templateId?: string | null;
789
+ /**
790
+ * Template settings external ID. For example ticket definition ID.
791
+ * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
792
+ * @minLength 1
793
+ * @maxLength 100
794
+ */
795
+ externalId?: string | null;
796
+ /**
797
+ * Date settings were created.
798
+ * @readonly
799
+ */
800
+ createdDate?: Date | null;
801
+ /**
802
+ * Date settings were updated.
803
+ * @readonly
804
+ */
805
+ updatedDate?: Date | null;
806
+ /** @maxSize 10 */
807
+ settingGroups?: SettingsGroup$1[];
808
+ /** Paper size */
809
+ paperSize?: PaperSizeWithLiterals$1;
810
+ pageOverflow?: PageOverflowWithLiterals$1;
811
+ }
812
+ interface TextSetting$1 {
813
+ /**
814
+ * Font family class name
815
+ * @maxLength 20
816
+ */
817
+ fontFamily?: string | null;
818
+ /**
819
+ * Font style class names
820
+ * @maxSize 10
821
+ * @maxLength 20
822
+ */
823
+ fontStyle?: string[];
824
+ /**
825
+ * Text alignment class name
826
+ * @maxLength 20
827
+ */
828
+ textAlignment?: string | null;
829
+ /**
830
+ * Text color hex code
831
+ * @minLength 7
832
+ * @maxLength 7
833
+ */
834
+ textColor?: string | null;
835
+ /**
836
+ * Font size
837
+ * @min 1
838
+ */
839
+ fontSize?: number | null;
840
+ /** Text content setting */
841
+ textContent?: TextContent$1[];
842
+ }
843
+ interface TextContent$1 {
844
+ /**
845
+ * @minLength 3
846
+ * @maxLength 50
847
+ */
848
+ id?: string;
849
+ /** @maxLength 500 */
850
+ value?: string | null;
851
+ visible?: boolean;
852
+ }
853
+ interface ImageSetting$1 {
854
+ /** Wix media Image */
855
+ image?: Image;
856
+ /** Image resizing mode */
857
+ resize?: ResizeOptionWithLiterals$1;
858
+ }
859
+ interface Image {
860
+ /** WixMedia image ID. */
861
+ id?: string;
862
+ /** Image URL. */
863
+ url?: string;
864
+ /**
865
+ * Original image height.
866
+ * @readonly
867
+ */
868
+ height?: number;
869
+ /**
870
+ * Original image width.
871
+ * @readonly
872
+ */
873
+ width?: number;
874
+ /** Image alt text. */
875
+ altText?: string | null;
876
+ /**
877
+ * Image filename.
878
+ * @readonly
879
+ */
880
+ filename?: string | null;
881
+ }
882
+ interface FocalPoint {
883
+ /** X-coordinate of the focal point. */
884
+ x?: number;
885
+ /** Y-coordinate of the focal point. */
886
+ y?: number;
887
+ /** crop by height */
888
+ height?: number | null;
889
+ /** crop by width */
890
+ width?: number | null;
891
+ }
892
+ declare enum ResizeOption$1 {
893
+ /** Automatically resizes full image to fit image field */
894
+ FIT = "FIT",
895
+ /** Enables user to manually crop image to fit image field */
896
+ CROP = "CROP"
897
+ }
898
+ /** @enumType */
899
+ type ResizeOptionWithLiterals$1 = ResizeOption$1 | 'FIT' | 'CROP';
900
+ interface SelectSetting$1 {
901
+ /** Selected value */
902
+ value?: string | null;
903
+ /**
904
+ * Color hex code
905
+ * @minLength 7
906
+ * @maxLength 7
907
+ */
908
+ primaryColor?: string | null;
909
+ /**
910
+ * Color hex code
911
+ * @minLength 7
912
+ * @maxLength 7
913
+ */
914
+ secondaryColor?: string | null;
915
+ /** Size */
916
+ size?: number | null;
917
+ }
918
+ interface BackgroundSetting$1 {
919
+ /**
920
+ * Color of the background hex code
921
+ * @minLength 7
922
+ * @maxLength 9
923
+ */
924
+ color?: string | null;
925
+ /** Wix media Image */
926
+ image?: Image;
927
+ }
928
+ interface SettingsGroup$1 {
929
+ /**
930
+ * Id of the control group
931
+ * @minLength 5
932
+ * @maxLength 50
933
+ */
934
+ groupId?: string;
935
+ /**
936
+ * Display settings.
937
+ * @maxSize 20
938
+ */
939
+ display?: Record<string, boolean>;
940
+ /**
941
+ * Texts settings.
942
+ * @maxSize 20
943
+ */
944
+ texts?: Record<string, TextSetting$1>;
945
+ /**
946
+ * Images settings.
947
+ * @maxSize 10
948
+ */
949
+ images?: Record<string, ImageSetting$1>;
950
+ /**
951
+ * Select option settings.
952
+ * @maxSize 20
953
+ */
954
+ selects?: Record<string, SelectSetting$1>;
955
+ /**
956
+ * Backgrounds settings.
957
+ * @maxSize 20
958
+ */
959
+ backgrounds?: Record<string, BackgroundSetting$1>;
960
+ }
961
+ declare enum PaperSize$1 {
962
+ A4_PORTRAIT = "A4_PORTRAIT",
963
+ A4_LANDSCAPE = "A4_LANDSCAPE"
964
+ }
965
+ /** @enumType */
966
+ type PaperSizeWithLiterals$1 = PaperSize$1 | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
967
+ declare enum PageOverflow$1 {
968
+ CONTENT_HIDDEN = "CONTENT_HIDDEN",
969
+ CONTENT_BREAK = "CONTENT_BREAK"
970
+ }
971
+ /** @enumType */
972
+ type PageOverflowWithLiterals$1 = PageOverflow$1 | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
973
+ interface CreateTemplateSettingsRequest {
974
+ /** Settings to be created. */
975
+ settings?: TemplateSettings$1;
976
+ }
977
+ interface CreateTemplateSettingsResponse {
978
+ /** Created settings. */
979
+ settings?: TemplateSettings$1;
980
+ }
981
+ interface BulkCreateTemplateSettingsRequest {
982
+ /**
983
+ * Settings to be created.
984
+ * @minSize 1
985
+ * @maxSize 100
986
+ */
987
+ settings?: TemplateSettings$1[];
988
+ }
989
+ interface BulkCreateTemplateSettingsResponse {
990
+ /** Created settings */
991
+ settings?: TemplateSettings$1[];
992
+ }
993
+ interface UpsertTemplateSettingsRequest$1 {
994
+ /** Settings to be upserted. */
995
+ settings?: TemplateSettings$1;
996
+ }
997
+ interface UpsertTemplateSettingsResponse$1 {
998
+ /** Upserted settings. */
999
+ settings?: TemplateSettings$1;
1000
+ }
1001
+ interface GetTemplateSettingsRequest {
1002
+ /**
1003
+ * Settings ID.
1004
+ * @format GUID
1005
+ */
1006
+ templateSettingsId?: string;
1007
+ }
1008
+ interface GetTemplateSettingsResponse {
1009
+ /** Retrieved settings. */
1010
+ settings?: TemplateSettings$1;
1011
+ }
1012
+ interface UpdateTemplateSettingsRequest {
1013
+ /** Template Settings to be updated. */
1014
+ settings?: TemplateSettings$1;
1015
+ }
1016
+ interface UpdateTemplateSettingsResponse {
1017
+ /** Updated settings. */
1018
+ settings?: TemplateSettings$1;
1019
+ }
1020
+ interface DeleteTemplateSettingsRequest {
1021
+ /**
1022
+ * Settings ID.
1023
+ * @format GUID
1024
+ */
1025
+ templateSettingsId?: string;
1026
+ }
1027
+ interface DeleteTemplateSettingsResponse {
1028
+ /** Deleted settings. */
1029
+ settings?: TemplateSettings$1;
1030
+ }
1031
+ interface QueryTemplateSettingsRequest$1 {
1032
+ /** Generic query object. */
1033
+ query: QueryV2$1;
1034
+ }
1035
+ interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 {
1036
+ /** Paging options to limit and offset the number of items. */
1037
+ paging?: Paging$1;
1038
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1039
+ cursorPaging?: CursorPaging$1;
1040
+ /**
1041
+ * Filter object.
1042
+ *
1043
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
1044
+ */
1045
+ filter?: Record<string, any> | null;
1046
+ /**
1047
+ * Sort object.
1048
+ *
1049
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
1050
+ */
1051
+ sort?: Sorting$1[];
1052
+ /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
1053
+ fields?: string[];
1054
+ /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
1055
+ fieldsets?: string[];
1056
+ }
1057
+ /** @oneof */
1058
+ interface QueryV2PagingMethodOneOf$1 {
1059
+ /** Paging options to limit and offset the number of items. */
1060
+ paging?: Paging$1;
1061
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1062
+ cursorPaging?: CursorPaging$1;
1063
+ }
1064
+ interface Sorting$1 {
1065
+ /**
1066
+ * Name of the field to sort by.
1067
+ * @maxLength 512
1068
+ */
1069
+ fieldName?: string;
1070
+ /** Sort order. */
1071
+ order?: SortOrderWithLiterals$1;
1072
+ }
1073
+ declare enum SortOrder$1 {
1074
+ ASC = "ASC",
1075
+ DESC = "DESC"
1076
+ }
1077
+ /** @enumType */
1078
+ type SortOrderWithLiterals$1 = SortOrder$1 | 'ASC' | 'DESC';
1079
+ interface Paging$1 {
1080
+ /** Number of items to load. */
1081
+ limit?: number | null;
1082
+ /** Number of items to skip in the current sort order. */
1083
+ offset?: number | null;
1084
+ }
1085
+ interface CursorPaging$1 {
1086
+ /**
1087
+ * Maximum number of items to return in the results.
1088
+ * @max 100
1089
+ */
1090
+ limit?: number | null;
1091
+ /**
1092
+ * Pointer to the next or previous page in the list of results.
1093
+ *
1094
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1095
+ * Not relevant for the first request.
1096
+ * @maxLength 16000
1097
+ */
1098
+ cursor?: string | null;
1099
+ }
1100
+ interface QueryTemplateSettingsResponse$1 {
1101
+ /** Template settings results. */
1102
+ settings?: TemplateSettings$1[];
1103
+ /** Query result's metadata. */
1104
+ metadata?: PagingMetadataV2$1;
1105
+ }
1106
+ interface PagingMetadataV2$1 {
1107
+ /** Number of items returned in the response. */
1108
+ count?: number | null;
1109
+ /** Offset that was requested. */
1110
+ offset?: number | null;
1111
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1112
+ total?: number | null;
1113
+ /** Flag that indicates the server failed to calculate the `total` field. */
1114
+ tooManyToCount?: boolean | null;
1115
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1116
+ cursors?: Cursors$1;
1117
+ }
1118
+ interface Cursors$1 {
1119
+ /**
1120
+ * Cursor string pointing to the next page in the list of results.
1121
+ * @maxLength 16000
1122
+ */
1123
+ next?: string | null;
1124
+ /**
1125
+ * Cursor pointing to the previous page in the list of results.
1126
+ * @maxLength 16000
1127
+ */
1128
+ prev?: string | null;
1129
+ }
1130
+ interface ResolveTemplateSettingsRequest$1 {
1131
+ /**
1132
+ * The id of the settings.
1133
+ * @format GUID
1134
+ */
1135
+ templateSettingsId?: string | null;
1136
+ /**
1137
+ * External ID.
1138
+ * @maxLength 100
1139
+ */
1140
+ templateSettingsExternalId?: string | null;
1141
+ /**
1142
+ * The type of the template. Used to resolve default settings.
1143
+ * @minLength 1
1144
+ * @maxLength 20
1145
+ */
1146
+ templateType: string | null;
1147
+ /**
1148
+ * Wix app slug.
1149
+ * @minLength 1
1150
+ * @maxLength 20
1151
+ */
1152
+ appSlug: string | null;
1153
+ /**
1154
+ * The id of template.
1155
+ * @minLength 1
1156
+ * @maxLength 20
1157
+ */
1158
+ templateId?: string | null;
1159
+ }
1160
+ interface ResolveTemplateSettingsResponse$1 {
1161
+ /** Retrieved settings. */
1162
+ settings?: TemplateSettings$1;
1163
+ }
1164
+ interface GetTemplateControlsRequest {
1165
+ }
1166
+ interface GetTemplateControlsResponse {
1167
+ templateControls?: TemplateControls;
1168
+ }
1169
+ interface TemplateControls {
1170
+ /**
1171
+ * The name of the template
1172
+ * @maxLength 50
1173
+ */
1174
+ templateName?: string;
1175
+ /**
1176
+ * The controls groups configuration
1177
+ * @minSize 1
1178
+ * @maxSize 10
1179
+ */
1180
+ controlGroups?: ControlGroup[];
1181
+ }
1182
+ /** Represents control groups on the left side of the UI */
1183
+ interface ControlGroup {
1184
+ /**
1185
+ * @minLength 3
1186
+ * @maxLength 50
1187
+ */
1188
+ groupId?: string;
1189
+ /**
1190
+ * @minLength 3
1191
+ * @maxLength 50
1192
+ */
1193
+ icon?: string;
1194
+ /**
1195
+ * @minLength 3
1196
+ * @maxLength 100
1197
+ */
1198
+ labelKey?: string;
1199
+ /**
1200
+ * @minLength 3
1201
+ * @maxLength 100
1202
+ */
1203
+ titleKey?: string;
1204
+ /**
1205
+ * @minLength 3
1206
+ * @maxLength 100
1207
+ */
1208
+ descriptionKey?: string;
1209
+ /** @maxLength 100 */
1210
+ linkKey?: string | null;
1211
+ /** @maxLength 50 */
1212
+ linkUrl?: string | null;
1213
+ /** @maxLength 100 */
1214
+ tooltipKey?: string | null;
1215
+ /**
1216
+ * Display controls
1217
+ * @maxSize 20
1218
+ */
1219
+ display?: DisplayControl[];
1220
+ /**
1221
+ * Text controls
1222
+ * @maxSize 20
1223
+ */
1224
+ texts?: TextControl[];
1225
+ /**
1226
+ * Image controls
1227
+ * @maxSize 10
1228
+ */
1229
+ images?: ImageControl[];
1230
+ /**
1231
+ * Select controls
1232
+ * @maxSize 20
1233
+ */
1234
+ selects?: SelectControl[];
1235
+ /**
1236
+ * Background controls
1237
+ * @maxSize 20
1238
+ */
1239
+ backgrounds?: BackgroundControl[];
1240
+ }
1241
+ interface DisplayControl {
1242
+ /**
1243
+ * The id of the setting
1244
+ * @maxLength 50
1245
+ */
1246
+ id?: string;
1247
+ /**
1248
+ * Optional label key for translations
1249
+ * @maxLength 100
1250
+ */
1251
+ labelKey?: string | null;
1252
+ /** Default setting for this control */
1253
+ default?: boolean;
1254
+ }
1255
+ interface TextControl {
1256
+ /**
1257
+ * The id of the setting
1258
+ * @maxLength 50
1259
+ */
1260
+ id?: string;
1261
+ /**
1262
+ * Optional label key for translations
1263
+ * @maxLength 100
1264
+ */
1265
+ labelKey?: string | null;
1266
+ /** Default setting for this control */
1267
+ default?: TextSetting$1;
1268
+ /**
1269
+ * Text properties
1270
+ * @maxSize 5
1271
+ */
1272
+ textProperties?: TextPropertyControl[];
1273
+ /** @maxSize 10 */
1274
+ textContent?: TextContentControl[];
1275
+ }
1276
+ interface TextPropertyControl {
1277
+ /**
1278
+ * One of "fontFamily", "fontStyle", "fontSize", "textAlignment"
1279
+ * @maxLength 15
1280
+ */
1281
+ type?: string;
1282
+ /**
1283
+ * Optional label key for translations
1284
+ * @maxLength 100
1285
+ */
1286
+ labelKey?: string | null;
1287
+ /**
1288
+ * List of possible options. Used for "fontFamily", "fontStyle", "textAlignment"
1289
+ * @maxSize 50
1290
+ */
1291
+ options?: ValueOption[];
1292
+ /** Optional range of the value. Used for "fontSize" */
1293
+ range?: Range;
1294
+ }
1295
+ interface ValueOption {
1296
+ /**
1297
+ * The label key for translations
1298
+ * @maxLength 100
1299
+ */
1300
+ labelKey?: string;
1301
+ /**
1302
+ * The value
1303
+ * @maxLength 20
1304
+ */
1305
+ value?: string;
1306
+ }
1307
+ interface Range {
1308
+ /** Minimum value. */
1309
+ min?: number | null;
1310
+ /** Maximum value. */
1311
+ max?: number | null;
1312
+ }
1313
+ interface TextContentControl {
1314
+ /**
1315
+ * @minLength 3
1316
+ * @maxLength 50
1317
+ */
1318
+ id?: string;
1319
+ /**
1320
+ * @minLength 3
1321
+ * @maxLength 100
1322
+ */
1323
+ labelKey?: string | null;
1324
+ /** @max 1000 */
1325
+ maxLength?: number | null;
1326
+ }
1327
+ interface ImageControl {
1328
+ /**
1329
+ * The id of the setting
1330
+ * @maxLength 50
1331
+ */
1332
+ id?: string;
1333
+ /**
1334
+ * Optional label key for translations
1335
+ * @maxLength 100
1336
+ */
1337
+ labelKey?: string | null;
1338
+ /** Default setting for this control */
1339
+ default?: ImageSetting$1;
1340
+ /**
1341
+ * Optional description key for translations
1342
+ * @maxLength 100
1343
+ */
1344
+ descriptionKey?: string | null;
1345
+ /** Enable logo builder support */
1346
+ showLogoBuilder?: boolean;
1347
+ }
1348
+ interface SelectControl {
1349
+ /**
1350
+ * The id of the setting
1351
+ * @maxLength 50
1352
+ */
1353
+ id?: string;
1354
+ /**
1355
+ * Optional label key for translations
1356
+ * @maxLength 100
1357
+ */
1358
+ labelKey?: string | null;
1359
+ /** Default setting for this control */
1360
+ default?: SelectSetting$1;
1361
+ /**
1362
+ * List of possible options
1363
+ * @minSize 1
1364
+ * @maxSize 20
1365
+ */
1366
+ options?: ValueOption[];
1367
+ /** Allows to use primary colour setting from template designer */
1368
+ showPrimaryColorPicker?: boolean;
1369
+ /** Allows to use secondary colour setting from template designer */
1370
+ showSecondaryColorPicker?: boolean;
1371
+ /** Allows to use size setting from template designer. */
1372
+ showSize?: boolean;
1373
+ /** Optional range of the size value. */
1374
+ sizeRange?: Range;
1375
+ }
1376
+ interface BackgroundControl {
1377
+ /**
1378
+ * The id of the setting
1379
+ * @maxLength 50
1380
+ */
1381
+ id?: string;
1382
+ /**
1383
+ * Optional label key for translations
1384
+ * @maxLength 100
1385
+ */
1386
+ labelKey?: string | null;
1387
+ /** Default setting for this control */
1388
+ default?: BackgroundSetting$1;
1389
+ /** Allows to use colour setting from template designer */
1390
+ showColorPicker?: boolean;
1391
+ /** Allows to use image setting from template designer */
1392
+ showImagePicker?: boolean;
1393
+ /** Enables background opacity control */
1394
+ opacityEnabled?: boolean | null;
1395
+ /** Enables background image opacity control */
1396
+ imageOpacityEnabled?: boolean | null;
1397
+ /**
1398
+ * Default media manager folder with background images
1399
+ * @maxLength 256
1400
+ */
1401
+ mediaRootFolder?: string | null;
1402
+ }
1403
+ interface GetTemplateRegistryRequest {
1404
+ }
1405
+ interface GetTemplateRegistryResponse {
1406
+ templateRegistry?: TemplateRegistry;
1407
+ }
1408
+ interface TemplateRegistry {
1409
+ /**
1410
+ * Templates.
1411
+ * @minSize 1
1412
+ * @maxSize 1000
1413
+ */
1414
+ templates?: WixAppTemplate[];
1415
+ }
1416
+ /** Defines a template and it's styles. */
1417
+ interface WixAppTemplate {
1418
+ /** Wix App Id */
1419
+ wixAppId?: string;
1420
+ /** App Slug */
1421
+ appSlug?: string;
1422
+ /**
1423
+ * Template type.
1424
+ * @minLength 1
1425
+ * @maxLength 20
1426
+ */
1427
+ templateType?: string;
1428
+ /**
1429
+ * Templates
1430
+ * @minSize 1
1431
+ * @maxSize 1000
1432
+ */
1433
+ templates?: TemplateStyle[];
1434
+ /**
1435
+ * Short artifact name (key from template-statics-config.json.erb)
1436
+ * @minLength 3
1437
+ * @maxLength 64
1438
+ * @format SYSTEM_SLUG
1439
+ */
1440
+ templateArtifactName?: string | null;
1441
+ /**
1442
+ * Local path
1443
+ * @minLength 1
1444
+ * @maxLength 200
1445
+ * @readonly
1446
+ */
1447
+ localPath?: string | null;
1448
+ /**
1449
+ * Statics URL
1450
+ * @minLength 1
1451
+ * @maxLength 200
1452
+ * @readonly
1453
+ */
1454
+ staticsUrl?: string | null;
1455
+ }
1456
+ /**
1457
+ * Defines a template style.
1458
+ *
1459
+ * Path to TemplateControls json file:
1460
+ * papyrus-templates-lib/
1461
+ * src/
1462
+ * templates/
1463
+ * {app_slug}/
1464
+ * {template_type}/
1465
+ * {id}/
1466
+ * controls.json
1467
+ */
1468
+ interface TemplateStyle {
1469
+ /**
1470
+ * The id of the template.
1471
+ * @minLength 1
1472
+ * @maxLength 20
1473
+ */
1474
+ id?: string;
1475
+ /**
1476
+ * Determines which template should be used if user did not choose it yet.
1477
+ * Only single template per wix_app_id can be default.
1478
+ */
1479
+ default?: boolean;
1480
+ /** Determines if template cannot be selected for a new entity. */
1481
+ inactive?: boolean;
1482
+ /** Paper size */
1483
+ paperSize?: PaperSizeWithLiterals$1;
1484
+ pageOverflow?: PageOverflowWithLiterals$1;
1485
+ }
1486
+ interface DomainEvent extends DomainEventBodyOneOf {
1487
+ createdEvent?: EntityCreatedEvent;
1488
+ updatedEvent?: EntityUpdatedEvent;
1489
+ deletedEvent?: EntityDeletedEvent;
1490
+ actionEvent?: ActionEvent;
1491
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1492
+ id?: string;
1493
+ /**
1494
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1495
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1496
+ */
1497
+ entityFqdn?: string;
1498
+ /**
1499
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1500
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1501
+ */
1502
+ slug?: string;
1503
+ /** ID of the entity associated with the event. */
1504
+ entityId?: string;
1505
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1506
+ eventTime?: Date | null;
1507
+ /**
1508
+ * Whether the event was triggered as a result of a privacy regulation application
1509
+ * (for example, GDPR).
1510
+ */
1511
+ triggeredByAnonymizeRequest?: boolean | null;
1512
+ /** If present, indicates the action that triggered the event. */
1513
+ originatedFrom?: string | null;
1514
+ /**
1515
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1516
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1517
+ */
1518
+ entityEventSequence?: string | null;
1519
+ }
1520
+ /** @oneof */
1521
+ interface DomainEventBodyOneOf {
1522
+ createdEvent?: EntityCreatedEvent;
1523
+ updatedEvent?: EntityUpdatedEvent;
1524
+ deletedEvent?: EntityDeletedEvent;
1525
+ actionEvent?: ActionEvent;
1526
+ }
1527
+ interface EntityCreatedEvent {
1528
+ entityAsJson?: string;
1529
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1530
+ restoreInfo?: RestoreInfo;
1531
+ }
1532
+ interface RestoreInfo {
1533
+ deletedDate?: Date | null;
1534
+ }
1535
+ interface EntityUpdatedEvent {
1536
+ /**
1537
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1538
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1539
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1540
+ */
1541
+ currentEntityAsJson?: string;
1542
+ }
1543
+ interface EntityDeletedEvent {
1544
+ /** Entity that was deleted. */
1545
+ deletedEntityAsJson?: string | null;
1546
+ }
1547
+ interface ActionEvent {
1548
+ bodyAsJson?: string;
1549
+ }
1550
+ interface MessageEnvelope {
1551
+ /**
1552
+ * App instance ID.
1553
+ * @format GUID
1554
+ */
1555
+ instanceId?: string | null;
1556
+ /**
1557
+ * Event type.
1558
+ * @maxLength 150
1559
+ */
1560
+ eventType?: string;
1561
+ /** The identification type and identity data. */
1562
+ identity?: IdentificationData;
1563
+ /** Stringify payload. */
1564
+ data?: string;
1565
+ /** Details related to the account */
1566
+ accountInfo?: AccountInfo;
1567
+ }
1568
+ interface IdentificationData extends IdentificationDataIdOneOf {
1569
+ /**
1570
+ * ID of a site visitor that has not logged in to the site.
1571
+ * @format GUID
1572
+ */
1573
+ anonymousVisitorId?: string;
1574
+ /**
1575
+ * ID of a site visitor that has logged in to the site.
1576
+ * @format GUID
1577
+ */
1578
+ memberId?: string;
1579
+ /**
1580
+ * ID of a Wix user (site owner, contributor, etc.).
1581
+ * @format GUID
1582
+ */
1583
+ wixUserId?: string;
1584
+ /**
1585
+ * ID of an app.
1586
+ * @format GUID
1587
+ */
1588
+ appId?: string;
1589
+ /** @readonly */
1590
+ identityType?: WebhookIdentityTypeWithLiterals;
1591
+ }
1592
+ /** @oneof */
1593
+ interface IdentificationDataIdOneOf {
1594
+ /**
1595
+ * ID of a site visitor that has not logged in to the site.
1596
+ * @format GUID
1597
+ */
1598
+ anonymousVisitorId?: string;
1599
+ /**
1600
+ * ID of a site visitor that has logged in to the site.
1601
+ * @format GUID
1602
+ */
1603
+ memberId?: string;
1604
+ /**
1605
+ * ID of a Wix user (site owner, contributor, etc.).
1606
+ * @format GUID
1607
+ */
1608
+ wixUserId?: string;
1609
+ /**
1610
+ * ID of an app.
1611
+ * @format GUID
1612
+ */
1613
+ appId?: string;
1614
+ }
1615
+ declare enum WebhookIdentityType {
1616
+ UNKNOWN = "UNKNOWN",
1617
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1618
+ MEMBER = "MEMBER",
1619
+ WIX_USER = "WIX_USER",
1620
+ APP = "APP"
1621
+ }
1622
+ /** @enumType */
1623
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1624
+ interface AccountInfo {
1625
+ /**
1626
+ * ID of the Wix account associated with the event.
1627
+ * @format GUID
1628
+ */
1629
+ accountId?: string | null;
1630
+ /**
1631
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
1632
+ * @format GUID
1633
+ */
1634
+ parentAccountId?: string | null;
1635
+ /**
1636
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
1637
+ * @format GUID
1638
+ */
1639
+ siteId?: string | null;
1640
+ }
1641
+ /** @docsIgnore */
1642
+ type UpsertTemplateSettingsApplicationErrors = {
1643
+ code?: 'INVALID_TEMPLATE_SETTINGS';
1644
+ description?: string;
1645
+ data?: Record<string, any>;
1646
+ };
1647
+ /** @docsIgnore */
1648
+ type ResolveTemplateSettingsApplicationErrors = {
1649
+ code?: 'TEMPLATE_NOT_FOUND';
1650
+ description?: string;
1651
+ data?: Record<string, any>;
1652
+ };
1653
+
1654
+ declare global {
1655
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
1656
+ interface SymbolConstructor {
1657
+ readonly observable: symbol;
1658
+ }
1659
+ }
1660
+
1661
+ declare global {
1662
+ interface ContextualClient {
1663
+ }
1664
+ }
1665
+ declare global {
1666
+ /**
1667
+ * A global interface to set the exposure toggle for the SDK.
1668
+ * @example
1669
+ * ```ts
1670
+ * declare global {
1671
+ * interface SDKExposureToggle {
1672
+ * alpha: true;
1673
+ * }
1674
+ * }
1675
+ */
1676
+ interface SDKExposureToggle {
1677
+ }
1678
+ }
1679
+
1680
+ declare global {
1681
+ /**
1682
+ * A global interface to set the type mode for the SDK.
1683
+ * @example
1684
+ * ```ts
1685
+ * declare global {
1686
+ * interface SDKTypeMode {
1687
+ * strict: true;
1688
+ * }
1689
+ * }
1690
+ */
1691
+ interface SDKTypeMode {
1692
+ }
1693
+ }
1694
+
1695
+ interface TemplateSettings {
1696
+ /**
1697
+ * Auto generated ID.
1698
+ * @format GUID
1699
+ * @readonly
1700
+ */
1701
+ _id?: string | null;
1702
+ /**
1703
+ * Wix app definition ID.
1704
+ * @minLength 1
1705
+ * @maxLength 20
1706
+ */
1707
+ appSlug?: string | null;
1708
+ /**
1709
+ * The type of the template.
1710
+ * @minLength 1
1711
+ * @maxLength 20
1712
+ */
1713
+ templateType?: string | null;
1714
+ /**
1715
+ * The id of the template.
1716
+ * @minLength 1
1717
+ * @maxLength 20
1718
+ */
1719
+ templateId?: string | null;
1720
+ /**
1721
+ * Template settings external ID. For example ticket definition ID.
1722
+ * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
1723
+ * @minLength 1
1724
+ * @maxLength 100
1725
+ */
1726
+ externalId?: string | null;
1727
+ /**
1728
+ * Date settings were created.
1729
+ * @readonly
1730
+ */
1731
+ _createdDate?: Date | null;
1732
+ /**
1733
+ * Date settings were updated.
1734
+ * @readonly
1735
+ */
1736
+ _updatedDate?: Date | null;
1737
+ /** @maxSize 10 */
1738
+ settingGroups?: SettingsGroup[];
1739
+ /** Paper size */
1740
+ paperSize?: PaperSizeWithLiterals;
1741
+ pageOverflow?: PageOverflowWithLiterals;
1742
+ }
1743
+ interface TextSetting {
1744
+ /**
1745
+ * Font family class name
1746
+ * @maxLength 20
1747
+ */
1748
+ fontFamily?: string | null;
1749
+ /**
1750
+ * Font style class names
1751
+ * @maxSize 10
1752
+ * @maxLength 20
1753
+ */
1754
+ fontStyle?: string[];
1755
+ /**
1756
+ * Text alignment class name
1757
+ * @maxLength 20
1758
+ */
1759
+ textAlignment?: string | null;
1760
+ /**
1761
+ * Text color hex code
1762
+ * @minLength 7
1763
+ * @maxLength 7
1764
+ */
1765
+ textColor?: string | null;
1766
+ /**
1767
+ * Font size
1768
+ * @min 1
1769
+ */
1770
+ fontSize?: number | null;
1771
+ /** Text content setting */
1772
+ textContent?: TextContent[];
1773
+ }
1774
+ interface TextContent {
1775
+ /**
1776
+ * @minLength 3
1777
+ * @maxLength 50
1778
+ */
1779
+ _id?: string;
1780
+ /** @maxLength 500 */
1781
+ value?: string | null;
1782
+ visible?: boolean;
1783
+ }
1784
+ interface ImageSetting {
1785
+ /** Wix media Image */
1786
+ image?: string;
1787
+ /** Image resizing mode */
1788
+ resize?: ResizeOptionWithLiterals;
1789
+ }
1790
+ declare enum ResizeOption {
1791
+ /** Automatically resizes full image to fit image field */
1792
+ FIT = "FIT",
1793
+ /** Enables user to manually crop image to fit image field */
1794
+ CROP = "CROP"
1795
+ }
1796
+ /** @enumType */
1797
+ type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
1798
+ interface SelectSetting {
1799
+ /** Selected value */
1800
+ value?: string | null;
1801
+ /**
1802
+ * Color hex code
1803
+ * @minLength 7
1804
+ * @maxLength 7
1805
+ */
1806
+ primaryColor?: string | null;
1807
+ /**
1808
+ * Color hex code
1809
+ * @minLength 7
1810
+ * @maxLength 7
1811
+ */
1812
+ secondaryColor?: string | null;
1813
+ /** Size */
1814
+ size?: number | null;
1815
+ }
1816
+ interface BackgroundSetting {
1817
+ /**
1818
+ * Color of the background hex code
1819
+ * @minLength 7
1820
+ * @maxLength 9
1821
+ */
1822
+ color?: string | null;
1823
+ /** Wix media Image */
1824
+ image?: string;
1825
+ }
1826
+ interface SettingsGroup {
1827
+ /**
1828
+ * Id of the control group
1829
+ * @minLength 5
1830
+ * @maxLength 50
1831
+ */
1832
+ groupId?: string;
1833
+ /**
1834
+ * Display settings.
1835
+ * @maxSize 20
1836
+ */
1837
+ display?: Record<string, boolean>;
1838
+ /**
1839
+ * Texts settings.
1840
+ * @maxSize 20
1841
+ */
1842
+ texts?: Record<string, TextSetting>;
1843
+ /**
1844
+ * Images settings.
1845
+ * @maxSize 10
1846
+ */
1847
+ images?: Record<string, ImageSetting>;
1848
+ /**
1849
+ * Select option settings.
1850
+ * @maxSize 20
1851
+ */
1852
+ selects?: Record<string, SelectSetting>;
1853
+ /**
1854
+ * Backgrounds settings.
1855
+ * @maxSize 20
1856
+ */
1857
+ backgrounds?: Record<string, BackgroundSetting>;
1858
+ }
1859
+ declare enum PaperSize {
1860
+ A4_PORTRAIT = "A4_PORTRAIT",
1861
+ A4_LANDSCAPE = "A4_LANDSCAPE"
1862
+ }
1863
+ /** @enumType */
1864
+ type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
1865
+ declare enum PageOverflow {
1866
+ CONTENT_HIDDEN = "CONTENT_HIDDEN",
1867
+ CONTENT_BREAK = "CONTENT_BREAK"
1868
+ }
1869
+ /** @enumType */
1870
+ type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
1871
+ interface UpsertTemplateSettingsRequest {
1872
+ /** Settings to be upserted. */
1873
+ settings?: TemplateSettings;
1874
+ }
1875
+ interface UpsertTemplateSettingsResponse {
1876
+ /** Upserted settings. */
1877
+ settings?: TemplateSettings;
1878
+ }
1879
+ interface QueryTemplateSettingsRequest {
1880
+ /** Generic query object. */
1881
+ query: QueryV2;
1882
+ }
1883
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
1884
+ /** Paging options to limit and offset the number of items. */
1885
+ paging?: Paging;
1886
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1887
+ cursorPaging?: CursorPaging;
1888
+ /**
1889
+ * Filter object.
1890
+ *
1891
+ * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
1892
+ */
1893
+ filter?: Record<string, any> | null;
1894
+ /**
1895
+ * Sort object.
1896
+ *
1897
+ * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
1898
+ */
1899
+ sort?: Sorting[];
1900
+ /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
1901
+ fields?: string[];
1902
+ /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
1903
+ fieldsets?: string[];
1904
+ }
1905
+ /** @oneof */
1906
+ interface QueryV2PagingMethodOneOf {
1907
+ /** Paging options to limit and offset the number of items. */
1908
+ paging?: Paging;
1909
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
1910
+ cursorPaging?: CursorPaging;
1911
+ }
1912
+ interface Sorting {
1913
+ /**
1914
+ * Name of the field to sort by.
1915
+ * @maxLength 512
1916
+ */
1917
+ fieldName?: string;
1918
+ /** Sort order. */
1919
+ order?: SortOrderWithLiterals;
1920
+ }
1921
+ declare enum SortOrder {
1922
+ ASC = "ASC",
1923
+ DESC = "DESC"
1924
+ }
1925
+ /** @enumType */
1926
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1927
+ interface Paging {
1928
+ /** Number of items to load. */
1929
+ limit?: number | null;
1930
+ /** Number of items to skip in the current sort order. */
1931
+ offset?: number | null;
1932
+ }
1933
+ interface CursorPaging {
1934
+ /**
1935
+ * Maximum number of items to return in the results.
1936
+ * @max 100
1937
+ */
1938
+ limit?: number | null;
1939
+ /**
1940
+ * Pointer to the next or previous page in the list of results.
1941
+ *
1942
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1943
+ * Not relevant for the first request.
1944
+ * @maxLength 16000
1945
+ */
1946
+ cursor?: string | null;
1947
+ }
1948
+ interface QueryTemplateSettingsResponse {
1949
+ /** Template settings results. */
1950
+ settings?: TemplateSettings[];
1951
+ /** Query result's metadata. */
1952
+ metadata?: PagingMetadataV2;
1953
+ }
1954
+ interface PagingMetadataV2 {
1955
+ /** Number of items returned in the response. */
1956
+ count?: number | null;
1957
+ /** Offset that was requested. */
1958
+ offset?: number | null;
1959
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1960
+ total?: number | null;
1961
+ /** Flag that indicates the server failed to calculate the `total` field. */
1962
+ tooManyToCount?: boolean | null;
1963
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1964
+ cursors?: Cursors;
1965
+ }
1966
+ interface Cursors {
1967
+ /**
1968
+ * Cursor string pointing to the next page in the list of results.
1969
+ * @maxLength 16000
1970
+ */
1971
+ next?: string | null;
1972
+ /**
1973
+ * Cursor pointing to the previous page in the list of results.
1974
+ * @maxLength 16000
1975
+ */
1976
+ prev?: string | null;
1977
+ }
1978
+ interface ResolveTemplateSettingsRequest {
1979
+ /**
1980
+ * The id of the settings.
1981
+ * @format GUID
1982
+ */
1983
+ templateSettingsId?: string | null;
1984
+ /**
1985
+ * External ID.
1986
+ * @maxLength 100
1987
+ */
1988
+ templateSettingsExternalId?: string | null;
1989
+ /**
1990
+ * The type of the template. Used to resolve default settings.
1991
+ * @minLength 1
1992
+ * @maxLength 20
1993
+ */
1994
+ templateType: string | null;
1995
+ /**
1996
+ * Wix app slug.
1997
+ * @minLength 1
1998
+ * @maxLength 20
1999
+ */
2000
+ appSlug: string | null;
2001
+ /**
2002
+ * The id of template.
2003
+ * @minLength 1
2004
+ * @maxLength 20
2005
+ */
2006
+ templateId?: string | null;
2007
+ }
2008
+ interface ResolveTemplateSettingsResponse {
2009
+ /** Retrieved settings. */
2010
+ settings?: TemplateSettings;
2011
+ }
2012
+
2013
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2014
+ getUrl: (context: any) => string;
2015
+ httpMethod: K;
2016
+ path: string;
2017
+ pathParams: M;
2018
+ __requestType: T;
2019
+ __originalRequestType: S;
2020
+ __responseType: Q;
2021
+ __originalResponseType: R;
2022
+ };
2023
+ declare function upsertTemplateSettings(): __PublicMethodMetaInfo<'POST', {}, UpsertTemplateSettingsRequest, UpsertTemplateSettingsRequest$1, UpsertTemplateSettingsResponse, UpsertTemplateSettingsResponse$1>;
2024
+ declare function queryTemplateSettings(): __PublicMethodMetaInfo<'POST', {}, QueryTemplateSettingsRequest, QueryTemplateSettingsRequest$1, QueryTemplateSettingsResponse, QueryTemplateSettingsResponse$1>;
2025
+ declare function resolveTemplateSettings(): __PublicMethodMetaInfo<'GET', {}, ResolveTemplateSettingsRequest, ResolveTemplateSettingsRequest$1, ResolveTemplateSettingsResponse, ResolveTemplateSettingsResponse$1>;
2026
+
2027
+ type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
2028
+ declare const meta_queryTemplateSettings: typeof queryTemplateSettings;
2029
+ declare const meta_resolveTemplateSettings: typeof resolveTemplateSettings;
2030
+ declare const meta_upsertTemplateSettings: typeof upsertTemplateSettings;
2031
+ declare namespace meta {
2032
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type BackgroundControl as BackgroundControlOriginal, type BackgroundSetting$1 as BackgroundSettingOriginal, type BulkCreateTemplateSettingsRequest as BulkCreateTemplateSettingsRequestOriginal, type BulkCreateTemplateSettingsResponse as BulkCreateTemplateSettingsResponseOriginal, type ControlGroup as ControlGroupOriginal, type CreateTemplateSettingsRequest as CreateTemplateSettingsRequestOriginal, type CreateTemplateSettingsResponse as CreateTemplateSettingsResponseOriginal, type CursorPaging$1 as CursorPagingOriginal, type Cursors$1 as CursorsOriginal, type DeleteTemplateSettingsRequest as DeleteTemplateSettingsRequestOriginal, type DeleteTemplateSettingsResponse as DeleteTemplateSettingsResponseOriginal, type DisplayControl as DisplayControlOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FocalPoint as FocalPointOriginal, type GetTemplateControlsRequest as GetTemplateControlsRequestOriginal, type GetTemplateControlsResponse as GetTemplateControlsResponseOriginal, type GetTemplateRegistryRequest as GetTemplateRegistryRequestOriginal, type GetTemplateRegistryResponse as GetTemplateRegistryResponseOriginal, type GetTemplateSettingsRequest as GetTemplateSettingsRequestOriginal, type GetTemplateSettingsResponse as GetTemplateSettingsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ImageControl as ImageControlOriginal, type Image as ImageOriginal, type ImageSetting$1 as ImageSettingOriginal, type MessageEnvelope as MessageEnvelopeOriginal, PageOverflow$1 as PageOverflowOriginal, type PageOverflowWithLiterals$1 as PageOverflowWithLiteralsOriginal, type PagingMetadataV2$1 as PagingMetadataV2Original, type Paging$1 as PagingOriginal, PaperSize$1 as PaperSizeOriginal, type PaperSizeWithLiterals$1 as PaperSizeWithLiteralsOriginal, type QueryTemplateSettingsRequest$1 as QueryTemplateSettingsRequestOriginal, type QueryTemplateSettingsResponse$1 as QueryTemplateSettingsResponseOriginal, type QueryV2$1 as QueryV2Original, type QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOfOriginal, type Range as RangeOriginal, ResizeOption$1 as ResizeOptionOriginal, type ResizeOptionWithLiterals$1 as ResizeOptionWithLiteralsOriginal, type ResolveTemplateSettingsApplicationErrors as ResolveTemplateSettingsApplicationErrorsOriginal, type ResolveTemplateSettingsRequest$1 as ResolveTemplateSettingsRequestOriginal, type ResolveTemplateSettingsResponse$1 as ResolveTemplateSettingsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type SelectControl as SelectControlOriginal, type SelectSetting$1 as SelectSettingOriginal, type SettingsGroup$1 as SettingsGroupOriginal, SortOrder$1 as SortOrderOriginal, type SortOrderWithLiterals$1 as SortOrderWithLiteralsOriginal, type Sorting$1 as SortingOriginal, type TemplateControls as TemplateControlsOriginal, type TemplateRegistry as TemplateRegistryOriginal, type TemplateSettings$1 as TemplateSettingsOriginal, type TemplateStyle as TemplateStyleOriginal, type TextContentControl as TextContentControlOriginal, type TextContent$1 as TextContentOriginal, type TextControl as TextControlOriginal, type TextPropertyControl as TextPropertyControlOriginal, type TextSetting$1 as TextSettingOriginal, type UpdateTemplateSettingsRequest as UpdateTemplateSettingsRequestOriginal, type UpdateTemplateSettingsResponse as UpdateTemplateSettingsResponseOriginal, type UpsertTemplateSettingsApplicationErrors as UpsertTemplateSettingsApplicationErrorsOriginal, type UpsertTemplateSettingsRequest$1 as UpsertTemplateSettingsRequestOriginal, type UpsertTemplateSettingsResponse$1 as UpsertTemplateSettingsResponseOriginal, type ValueOption as ValueOptionOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixAppTemplate as WixAppTemplateOriginal, type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_queryTemplateSettings as queryTemplateSettings, meta_resolveTemplateSettings as resolveTemplateSettings, meta_upsertTemplateSettings as upsertTemplateSettings };
763
2033
  }
764
2034
 
765
- export { meta_d as documents };
2035
+ export { meta_d as documents, meta as templates };