@wix/multilingual 1.0.22 → 1.0.24

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.
@@ -5791,6 +5791,14 @@ interface UpdateContentResponse$1 {
5791
5791
  /** Updated Content. */
5792
5792
  content?: Content$1;
5793
5793
  }
5794
+ interface UpdateContentByKeyRequest$1 {
5795
+ /** Content to be updated, may be partial. */
5796
+ content: Content$1;
5797
+ }
5798
+ interface UpdateContentByKeyResponse$1 {
5799
+ /** Updated Content. */
5800
+ content?: Content$1;
5801
+ }
5794
5802
  interface DeleteContentRequest$1 {
5795
5803
  /** Id of the Content to delete. */
5796
5804
  contentId: string;
@@ -5802,26 +5810,32 @@ interface QueryContentsRequest$1 {
5802
5810
  query?: CursorQuery$3;
5803
5811
  }
5804
5812
  interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {
5805
- /** 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`. */
5813
+ /**
5814
+ * Cursor paging options.
5815
+ *
5816
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
5817
+ */
5806
5818
  cursorPaging?: CursorPaging$3;
5807
5819
  /**
5808
- * Filter object in the following format:
5809
- * `"filter" : {
5810
- * "fieldName1": "value1",
5811
- * "fieldName2":{"$operator":"value2"}
5812
- * }`
5813
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
5820
+ * Filter object.
5821
+ *
5822
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
5814
5823
  */
5815
5824
  filter?: Record<string, any> | null;
5816
5825
  /**
5817
- * Sort object in the following format:
5818
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
5826
+ * Sort object.
5827
+ *
5828
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
5819
5829
  */
5820
5830
  sort?: Sorting$3[];
5821
5831
  }
5822
5832
  /** @oneof */
5823
5833
  interface CursorQueryPagingMethodOneOf$3 {
5824
- /** 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`. */
5834
+ /**
5835
+ * Cursor paging options.
5836
+ *
5837
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
5838
+ */
5825
5839
  cursorPaging?: CursorPaging$3;
5826
5840
  }
5827
5841
  interface Sorting$3 {
@@ -5875,17 +5889,26 @@ interface SearchContentsRequest$1 {
5875
5889
  }
5876
5890
  interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {
5877
5891
  /**
5878
- * Cursor pointing to page of results.
5879
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
5892
+ * Cursor paging options.
5893
+ *
5894
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
5880
5895
  */
5881
5896
  cursorPaging?: CursorPaging$3;
5882
- /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
5897
+ /**
5898
+ * Filter object.
5899
+ *
5900
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
5901
+ */
5883
5902
  filter?: Record<string, any> | null;
5884
- /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
5903
+ /**
5904
+ * List of sort objects.
5905
+ *
5906
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
5907
+ */
5885
5908
  sort?: Sorting$3[];
5886
5909
  /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
5887
5910
  aggregations?: Aggregation$1[];
5888
- /** Free text to match in searchable fields */
5911
+ /** Free text to match in searchable fields. */
5889
5912
  search?: SearchDetails$1;
5890
5913
  /**
5891
5914
  * UTC offset or IANA time zone. Valid values are
@@ -5901,8 +5924,9 @@ interface CursorSearch$1 extends CursorSearchPagingMethodOneOf$1 {
5901
5924
  /** @oneof */
5902
5925
  interface CursorSearchPagingMethodOneOf$1 {
5903
5926
  /**
5904
- * Cursor pointing to page of results.
5905
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
5927
+ * Cursor paging options.
5928
+ *
5929
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
5906
5930
  */
5907
5931
  cursorPaging?: CursorPaging$3;
5908
5932
  }
@@ -6331,11 +6355,11 @@ interface BulkActionMetadata$1 {
6331
6355
  }
6332
6356
  interface BulkUpdateContentRequest$1 {
6333
6357
  /** Contents to be updated. TODO: think again if we want to increase maxSize */
6334
- contents: MaskedContent$1[];
6358
+ contents: BulkUpdateContentRequestMaskedContent$1[];
6335
6359
  /** set to `true` if you wish to receive back the created contents in the response */
6336
6360
  returnEntity?: boolean;
6337
6361
  }
6338
- interface MaskedContent$1 {
6362
+ interface BulkUpdateContentRequestMaskedContent$1 {
6339
6363
  /** Content to be updated, may be partial */
6340
6364
  content?: Content$1;
6341
6365
  }
@@ -6351,6 +6375,28 @@ interface BulkUpdateContentResponseBulkContentResult$1 {
6351
6375
  /** Only exists if `returnEntity` was set to true in the request */
6352
6376
  item?: Content$1;
6353
6377
  }
6378
+ interface BulkUpdateContentByKeyRequest$1 {
6379
+ /** Contents to be updated. TODO: think again if we want to increase maxSize */
6380
+ contents: MaskedContent$1[];
6381
+ /** set to `true` if you wish to receive back the created contents in the response */
6382
+ returnEntity?: boolean;
6383
+ }
6384
+ interface MaskedContent$1 {
6385
+ /** Content to be updated, may be partial */
6386
+ content?: Content$1;
6387
+ }
6388
+ interface BulkUpdateContentByKeyResponse$1 {
6389
+ /** List of results */
6390
+ results?: BulkUpdateContentByKeyResponseBulkContentResult$1[];
6391
+ /** metadata */
6392
+ bulkActionMetadata?: BulkActionMetadata$1;
6393
+ }
6394
+ interface BulkUpdateContentByKeyResponseBulkContentResult$1 {
6395
+ /** metadata */
6396
+ itemMetadata?: ItemMetadata$1;
6397
+ /** Only exists if `returnEntity` was set to true in the request */
6398
+ item?: Content$1;
6399
+ }
6354
6400
  interface BulkDeleteContentRequest$1 {
6355
6401
  /** Content ids to be deleted. TODO: think again if we want to increase maxSize */
6356
6402
  contentIds: string[];
@@ -6380,6 +6426,9 @@ interface GetContentResponseNonNullableFields$1 {
6380
6426
  interface UpdateContentResponseNonNullableFields$1 {
6381
6427
  content?: ContentNonNullableFields$1;
6382
6428
  }
6429
+ interface UpdateContentByKeyResponseNonNullableFields$1 {
6430
+ content?: ContentNonNullableFields$1;
6431
+ }
6383
6432
  interface QueryContentsResponseNonNullableFields$1 {
6384
6433
  contents: ContentNonNullableFields$1[];
6385
6434
  }
@@ -6469,6 +6518,14 @@ interface BulkUpdateContentResponseNonNullableFields$1 {
6469
6518
  results: BulkUpdateContentResponseBulkContentResultNonNullableFields$1[];
6470
6519
  bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
6471
6520
  }
6521
+ interface BulkUpdateContentByKeyResponseBulkContentResultNonNullableFields$1 {
6522
+ itemMetadata?: ItemMetadataNonNullableFields$1;
6523
+ item?: ContentNonNullableFields$1;
6524
+ }
6525
+ interface BulkUpdateContentByKeyResponseNonNullableFields$1 {
6526
+ results: BulkUpdateContentByKeyResponseBulkContentResultNonNullableFields$1[];
6527
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
6528
+ }
6472
6529
  interface BulkDeleteContentResponseBulkContentResultNonNullableFields$1 {
6473
6530
  itemMetadata?: ItemMetadataNonNullableFields$1;
6474
6531
  }
@@ -7804,6 +7861,14 @@ interface UpdateContentResponse {
7804
7861
  /** Updated Content. */
7805
7862
  content?: Content;
7806
7863
  }
7864
+ interface UpdateContentByKeyRequest {
7865
+ /** Content to be updated, may be partial. */
7866
+ content: Content;
7867
+ }
7868
+ interface UpdateContentByKeyResponse {
7869
+ /** Updated Content. */
7870
+ content?: Content;
7871
+ }
7807
7872
  interface DeleteContentRequest {
7808
7873
  /** Id of the Content to delete. */
7809
7874
  contentId: string;
@@ -7815,26 +7880,32 @@ interface QueryContentsRequest {
7815
7880
  query?: CursorQuery$2;
7816
7881
  }
7817
7882
  interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
7818
- /** 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`. */
7883
+ /**
7884
+ * Cursor paging options.
7885
+ *
7886
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
7887
+ */
7819
7888
  cursorPaging?: CursorPaging$2;
7820
7889
  /**
7821
- * Filter object in the following format:
7822
- * `"filter" : {
7823
- * "fieldName1": "value1",
7824
- * "fieldName2":{"$operator":"value2"}
7825
- * }`
7826
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
7890
+ * Filter object.
7891
+ *
7892
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
7827
7893
  */
7828
7894
  filter?: Record<string, any> | null;
7829
7895
  /**
7830
- * Sort object in the following format:
7831
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
7896
+ * Sort object.
7897
+ *
7898
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
7832
7899
  */
7833
7900
  sort?: Sorting$2[];
7834
7901
  }
7835
7902
  /** @oneof */
7836
7903
  interface CursorQueryPagingMethodOneOf$2 {
7837
- /** 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`. */
7904
+ /**
7905
+ * Cursor paging options.
7906
+ *
7907
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
7908
+ */
7838
7909
  cursorPaging?: CursorPaging$2;
7839
7910
  }
7840
7911
  interface Sorting$2 {
@@ -7888,17 +7959,26 @@ interface SearchContentsRequest {
7888
7959
  }
7889
7960
  interface CursorSearch extends CursorSearchPagingMethodOneOf {
7890
7961
  /**
7891
- * Cursor pointing to page of results.
7892
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
7962
+ * Cursor paging options.
7963
+ *
7964
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
7893
7965
  */
7894
7966
  cursorPaging?: CursorPaging$2;
7895
- /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
7967
+ /**
7968
+ * Filter object.
7969
+ *
7970
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
7971
+ */
7896
7972
  filter?: Record<string, any> | null;
7897
- /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
7973
+ /**
7974
+ * List of sort objects.
7975
+ *
7976
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
7977
+ */
7898
7978
  sort?: Sorting$2[];
7899
7979
  /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
7900
7980
  aggregations?: Aggregation[];
7901
- /** Free text to match in searchable fields */
7981
+ /** Free text to match in searchable fields. */
7902
7982
  search?: SearchDetails;
7903
7983
  /**
7904
7984
  * UTC offset or IANA time zone. Valid values are
@@ -7914,8 +7994,9 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
7914
7994
  /** @oneof */
7915
7995
  interface CursorSearchPagingMethodOneOf {
7916
7996
  /**
7917
- * Cursor pointing to page of results.
7918
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
7997
+ * Cursor paging options.
7998
+ *
7999
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
7919
8000
  */
7920
8001
  cursorPaging?: CursorPaging$2;
7921
8002
  }
@@ -8344,11 +8425,11 @@ interface BulkActionMetadata {
8344
8425
  }
8345
8426
  interface BulkUpdateContentRequest {
8346
8427
  /** Contents to be updated. TODO: think again if we want to increase maxSize */
8347
- contents: MaskedContent[];
8428
+ contents: BulkUpdateContentRequestMaskedContent[];
8348
8429
  /** set to `true` if you wish to receive back the created contents in the response */
8349
8430
  returnEntity?: boolean;
8350
8431
  }
8351
- interface MaskedContent {
8432
+ interface BulkUpdateContentRequestMaskedContent {
8352
8433
  /** Content to be updated, may be partial */
8353
8434
  content?: Content;
8354
8435
  }
@@ -8364,6 +8445,28 @@ interface BulkUpdateContentResponseBulkContentResult {
8364
8445
  /** Only exists if `returnEntity` was set to true in the request */
8365
8446
  item?: Content;
8366
8447
  }
8448
+ interface BulkUpdateContentByKeyRequest {
8449
+ /** Contents to be updated. TODO: think again if we want to increase maxSize */
8450
+ contents: MaskedContent[];
8451
+ /** set to `true` if you wish to receive back the created contents in the response */
8452
+ returnEntity?: boolean;
8453
+ }
8454
+ interface MaskedContent {
8455
+ /** Content to be updated, may be partial */
8456
+ content?: Content;
8457
+ }
8458
+ interface BulkUpdateContentByKeyResponse {
8459
+ /** List of results */
8460
+ results?: BulkUpdateContentByKeyResponseBulkContentResult[];
8461
+ /** metadata */
8462
+ bulkActionMetadata?: BulkActionMetadata;
8463
+ }
8464
+ interface BulkUpdateContentByKeyResponseBulkContentResult {
8465
+ /** metadata */
8466
+ itemMetadata?: ItemMetadata;
8467
+ /** Only exists if `returnEntity` was set to true in the request */
8468
+ item?: Content;
8469
+ }
8367
8470
  interface BulkDeleteContentRequest {
8368
8471
  /** Content ids to be deleted. TODO: think again if we want to increase maxSize */
8369
8472
  contentIds: string[];
@@ -8393,6 +8496,9 @@ interface GetContentResponseNonNullableFields {
8393
8496
  interface UpdateContentResponseNonNullableFields {
8394
8497
  content?: ContentNonNullableFields;
8395
8498
  }
8499
+ interface UpdateContentByKeyResponseNonNullableFields {
8500
+ content?: ContentNonNullableFields;
8501
+ }
8396
8502
  interface QueryContentsResponseNonNullableFields {
8397
8503
  contents: ContentNonNullableFields[];
8398
8504
  }
@@ -8482,6 +8588,14 @@ interface BulkUpdateContentResponseNonNullableFields {
8482
8588
  results: BulkUpdateContentResponseBulkContentResultNonNullableFields[];
8483
8589
  bulkActionMetadata?: BulkActionMetadataNonNullableFields;
8484
8590
  }
8591
+ interface BulkUpdateContentByKeyResponseBulkContentResultNonNullableFields {
8592
+ itemMetadata?: ItemMetadataNonNullableFields;
8593
+ item?: ContentNonNullableFields;
8594
+ }
8595
+ interface BulkUpdateContentByKeyResponseNonNullableFields {
8596
+ results: BulkUpdateContentByKeyResponseBulkContentResultNonNullableFields[];
8597
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
8598
+ }
8485
8599
  interface BulkDeleteContentResponseBulkContentResultNonNullableFields {
8486
8600
  itemMetadata?: ItemMetadataNonNullableFields;
8487
8601
  }
@@ -8504,7 +8618,10 @@ declare function createContent(): __PublicMethodMetaInfo$1<'POST', {}, CreateCon
8504
8618
  declare function getContent(): __PublicMethodMetaInfo$1<'GET', {
8505
8619
  contentId: string;
8506
8620
  }, GetContentRequest, GetContentRequest$1, GetContentResponse & GetContentResponseNonNullableFields, GetContentResponse$1 & GetContentResponseNonNullableFields$1>;
8507
- declare function updateContent(): __PublicMethodMetaInfo$1<'PATCH', {}, UpdateContentRequest, UpdateContentRequest$1, UpdateContentResponse & UpdateContentResponseNonNullableFields, UpdateContentResponse$1 & UpdateContentResponseNonNullableFields$1>;
8621
+ declare function updateContent(): __PublicMethodMetaInfo$1<'PATCH', {
8622
+ contentId: string;
8623
+ }, UpdateContentRequest, UpdateContentRequest$1, UpdateContentResponse & UpdateContentResponseNonNullableFields, UpdateContentResponse$1 & UpdateContentResponseNonNullableFields$1>;
8624
+ declare function updateContentByKey(): __PublicMethodMetaInfo$1<'PATCH', {}, UpdateContentByKeyRequest, UpdateContentByKeyRequest$1, UpdateContentByKeyResponse & UpdateContentByKeyResponseNonNullableFields, UpdateContentByKeyResponse$1 & UpdateContentByKeyResponseNonNullableFields$1>;
8508
8625
  declare function deleteContent(): __PublicMethodMetaInfo$1<'DELETE', {
8509
8626
  contentId: string;
8510
8627
  }, DeleteContentRequest, DeleteContentRequest$1, DeleteContentResponse, DeleteContentResponse$1>;
@@ -8512,19 +8629,22 @@ declare function queryContents(): __PublicMethodMetaInfo$1<'POST', {}, QueryCont
8512
8629
  declare function searchContents(): __PublicMethodMetaInfo$1<'POST', {}, SearchContentsRequest, SearchContentsRequest$1, SearchContentsResponse & SearchContentsResponseNonNullableFields, SearchContentsResponse$1 & SearchContentsResponseNonNullableFields$1>;
8513
8630
  declare function bulkCreateContent(): __PublicMethodMetaInfo$1<'POST', {}, BulkCreateContentRequest, BulkCreateContentRequest$1, BulkCreateContentResponse & BulkCreateContentResponseNonNullableFields, BulkCreateContentResponse$1 & BulkCreateContentResponseNonNullableFields$1>;
8514
8631
  declare function bulkUpdateContent(): __PublicMethodMetaInfo$1<'POST', {}, BulkUpdateContentRequest, BulkUpdateContentRequest$1, BulkUpdateContentResponse & BulkUpdateContentResponseNonNullableFields, BulkUpdateContentResponse$1 & BulkUpdateContentResponseNonNullableFields$1>;
8632
+ declare function bulkUpdateContentByKey(): __PublicMethodMetaInfo$1<'POST', {}, BulkUpdateContentByKeyRequest, BulkUpdateContentByKeyRequest$1, BulkUpdateContentByKeyResponse & BulkUpdateContentByKeyResponseNonNullableFields, BulkUpdateContentByKeyResponse$1 & BulkUpdateContentByKeyResponseNonNullableFields$1>;
8515
8633
  declare function bulkDeleteContent(): __PublicMethodMetaInfo$1<'POST', {}, BulkDeleteContentRequest, BulkDeleteContentRequest$1, BulkDeleteContentResponse & BulkDeleteContentResponseNonNullableFields, BulkDeleteContentResponse$1 & BulkDeleteContentResponseNonNullableFields$1>;
8516
8634
 
8517
8635
  declare const meta$1_bulkCreateContent: typeof bulkCreateContent;
8518
8636
  declare const meta$1_bulkDeleteContent: typeof bulkDeleteContent;
8519
8637
  declare const meta$1_bulkUpdateContent: typeof bulkUpdateContent;
8638
+ declare const meta$1_bulkUpdateContentByKey: typeof bulkUpdateContentByKey;
8520
8639
  declare const meta$1_createContent: typeof createContent;
8521
8640
  declare const meta$1_deleteContent: typeof deleteContent;
8522
8641
  declare const meta$1_getContent: typeof getContent;
8523
8642
  declare const meta$1_queryContents: typeof queryContents;
8524
8643
  declare const meta$1_searchContents: typeof searchContents;
8525
8644
  declare const meta$1_updateContent: typeof updateContent;
8645
+ declare const meta$1_updateContentByKey: typeof updateContentByKey;
8526
8646
  declare namespace meta$1 {
8527
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_bulkCreateContent as bulkCreateContent, meta$1_bulkDeleteContent as bulkDeleteContent, meta$1_bulkUpdateContent as bulkUpdateContent, meta$1_createContent as createContent, meta$1_deleteContent as deleteContent, meta$1_getContent as getContent, meta$1_queryContents as queryContents, meta$1_searchContents as searchContents, meta$1_updateContent as updateContent };
8647
+ export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_bulkCreateContent as bulkCreateContent, meta$1_bulkDeleteContent as bulkDeleteContent, meta$1_bulkUpdateContent as bulkUpdateContent, meta$1_bulkUpdateContentByKey as bulkUpdateContentByKey, meta$1_createContent as createContent, meta$1_deleteContent as deleteContent, meta$1_getContent as getContent, meta$1_queryContents as queryContents, meta$1_searchContents as searchContents, meta$1_updateContent as updateContent, meta$1_updateContentByKey as updateContentByKey };
8528
8648
  }
8529
8649
 
8530
8650
  interface Schema$1 {