@wix/bex-utils 2.31.0 → 2.32.0

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.
Files changed (114) hide show
  1. package/package.json +2 -3
  2. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/builders.impl.d.ts +0 -89
  3. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/builders.impl.js +0 -2249
  4. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/builders.impl.js.map +0 -1
  5. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/crud/http.impl.d.ts +0 -1
  6. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/crud/http.impl.js +0 -5
  7. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/crud/http.impl.js.map +0 -1
  8. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/crud/rpc.impl.d.ts +0 -6
  9. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/crud/rpc.impl.js +0 -24
  10. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/crud/rpc.impl.js.map +0 -1
  11. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/http.impl.d.ts +0 -180
  12. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/http.impl.js +0 -971
  13. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/http.impl.js.map +0 -1
  14. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/meta.impl.d.ts +0 -30
  15. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/meta.impl.js +0 -385
  16. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/meta.impl.js.map +0 -1
  17. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/proto/client/proto-generated.d.ts +0 -10010
  18. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/proto/client/proto-generated.js +0 -2
  19. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/proto/proto-generated.d.ts +0 -5002
  20. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/proto/proto-generated.js +0 -78224
  21. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/proto/server/proto-generated.d.ts +0 -9973
  22. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/proto/server/proto-generated.js +0 -2
  23. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/rpc.impl.d.ts +0 -189
  24. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/rpc.impl.js +0 -431
  25. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/rpc.impl.js.map +0 -1
  26. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/types.impl.d.ts +0 -1387
  27. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/types.impl.js +0 -117
  28. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/cjs/types.impl.js.map +0 -1
  29. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/builders.impl.d.ts +0 -89
  30. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/builders.impl.js +0 -2145
  31. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/builders.impl.js.map +0 -1
  32. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/crud/http.impl.d.ts +0 -1
  33. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/crud/http.impl.js +0 -2
  34. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/crud/http.impl.js.map +0 -1
  35. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/crud/rpc.impl.d.ts +0 -6
  36. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/crud/rpc.impl.js +0 -19
  37. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/crud/rpc.impl.js.map +0 -1
  38. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/http.impl.d.ts +0 -180
  39. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/http.impl.js +0 -949
  40. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/http.impl.js.map +0 -1
  41. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/meta.impl.d.ts +0 -30
  42. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/meta.impl.js +0 -344
  43. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/meta.impl.js.map +0 -1
  44. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/rpc.impl.d.ts +0 -189
  45. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/rpc.impl.js +0 -390
  46. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/rpc.impl.js.map +0 -1
  47. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/types.impl.d.ts +0 -1387
  48. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/types.impl.js +0 -114
  49. package/@wix/ambassador-media-site-media-v1-file-descriptor/build/es/types.impl.js.map +0 -1
  50. package/@wix/ambassador-media-site-media-v1-file-descriptor/builders/package.json +0 -7
  51. package/@wix/ambassador-media-site-media-v1-file-descriptor/crud/http/package.json +0 -7
  52. package/@wix/ambassador-media-site-media-v1-file-descriptor/crud/rpc/package.json +0 -6
  53. package/@wix/ambassador-media-site-media-v1-file-descriptor/http/package.json +0 -7
  54. package/@wix/ambassador-media-site-media-v1-file-descriptor/meta/package.json +0 -7
  55. package/@wix/ambassador-media-site-media-v1-file-descriptor/package.json +0 -53
  56. package/@wix/ambassador-media-site-media-v1-file-descriptor/rpc/package.json +0 -6
  57. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/media_manager/v1/media_manager_entity.proto +0 -17
  58. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/media_manager/v1/media_manager_service.proto +0 -121
  59. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/media_manager/v1/search_result.proto +0 -17
  60. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/media_manager/v1/search_service.proto +0 -76
  61. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/media_quota_api.proto +0 -159
  62. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/upstream/wix/common/identification.proto +0 -41
  63. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/upstream/wix/common/media.proto +0 -242
  64. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/upstream/wix/common/paging.proto +0 -121
  65. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/audio_v2.proto +0 -31
  66. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/content_disposition.proto +0 -11
  67. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/download_url.proto +0 -12
  68. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/error_code.proto +0 -49
  69. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/errors.proto +0 -41
  70. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/file_descriptor.proto +0 -140
  71. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/files_service.proto +0 -1030
  72. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/folder.proto +0 -48
  73. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/folders_service.proto +0 -367
  74. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/identity_info.proto +0 -13
  75. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/image_media.proto +0 -84
  76. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/media_type.proto +0 -15
  77. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/namespace.proto +0 -21
  78. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/operation_status.proto +0 -27
  79. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/other_media.proto +0 -22
  80. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/root_folders.proto +0 -12
  81. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/storage_info.proto +0 -24
  82. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/storage_service.proto +0 -179
  83. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/com/wix/media/site_media/v1/upload_protocol.proto +0 -9
  84. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/action_payload.proto +0 -33
  85. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/annotations.proto +0 -393
  86. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/api_errors.proto +0 -117
  87. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/callback.proto +0 -156
  88. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/context.proto +0 -19
  89. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/entity.proto +0 -122
  90. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/errors.proto +0 -119
  91. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/idempotency.proto +0 -25
  92. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/permissions.proto +0 -40
  93. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/sla.proto +0 -24
  94. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/subscription.proto +0 -32
  95. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/api/validations.proto +0 -137
  96. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/address.proto +0 -148
  97. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/bulk.proto +0 -53
  98. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/identification.proto +0 -40
  99. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/image.proto +0 -8
  100. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/media.proto +0 -236
  101. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/money.proto +0 -32
  102. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/pageurl.proto +0 -32
  103. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/paging.proto +0 -121
  104. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/query.proto +0 -795
  105. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/sorting.proto +0 -36
  106. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/spi.proto +0 -85
  107. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/tags.proto +0 -55
  108. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/common/wixlink.proto +0 -201
  109. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/graphql/definitions.proto +0 -13
  110. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/http/field_mask.proto +0 -46
  111. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/sdk/definitions.proto +0 -191
  112. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/spi/definitions.proto +0 -186
  113. package/@wix/ambassador-media-site-media-v1-file-descriptor/src/main/proto/wix/spi/http_error_status.proto +0 -24
  114. package/@wix/ambassador-media-site-media-v1-file-descriptor/types/package.json +0 -7
@@ -1,179 +0,0 @@
1
- syntax = "proto3";
2
-
3
- package com.wix.media.site_media.v1;
4
-
5
- import "wix/api/validations.proto";
6
- import "wix/api/permissions.proto";
7
- import "wix/api/annotations.proto";
8
- import "google/api/annotations.proto";
9
- import "google/protobuf/field_mask.proto";
10
- import "google/protobuf/wrappers.proto";
11
- import "com/wix/media/site_media/v1/file_descriptor.proto";
12
- import "com/wix/media/site_media/v1/identity_info.proto";
13
- import "com/wix/media/site_media/v1/download_url.proto";
14
- import "com/wix/media/site_media/v1/media_type.proto";
15
- import "com/wix/media/site_media/v1/namespace.proto";
16
- import "com/wix/media/site_media/v1/upload_protocol.proto";
17
- import "com/wix/media/site_media/v1/root_folders.proto";
18
- import "wix/api/entity.proto";
19
- import "com/wix/media/site_media/upstream/wix/common/paging.proto";
20
- import "wix/api/callback.proto";
21
- import "wix/common/sorting.proto";
22
- import "wix/api/api_errors.proto";
23
- import "google/protobuf/struct.proto";
24
- import "wix/http/field_mask.proto";
25
- import "google/protobuf/timestamp.proto";
26
- import "com/wix/media/media_quota_api.proto";
27
-
28
-
29
-
30
-
31
- message ListStorageFilesRequest {
32
- /* ID of the file's parent folder. <br />
33
- Default:`media-root`.
34
- */
35
- // google.protobuf.StringValue parent_folder_id = 1 [(.wix.api.maxLength) = 100];
36
- reserved 1;
37
-
38
-
39
- // File media type.
40
- repeated MediaType media_types = 3 [(.wix.api.maxSize) = 30];
41
- // \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
42
- // google.protobuf.BoolValue private = 4;
43
- reserved 4;
44
- // Field name and order to sort by. One of: <br />
45
- // * `displayName`
46
- // * `updatedDate`
47
- // * `sizeInBytes`
48
- // * `lastUsedDate`
49
- // Default: `updatedDate` in `desc` order.
50
- .wix.common.Sorting sort = 5;
51
- // Cursor and paging information.
52
- com.wix.media.site_media.upstream.wix.common.CursorPaging paging = 6;
53
-
54
- // List files of the specified namespace
55
- // google.protobuf.StringValue raw_namespace = 12 [(.wix.api.field_exposure) = INTERNAL, (.wix.api.maxLength) = 100];
56
- reserved 12;
57
-
58
- // Get files with update date greater than set value
59
- google.protobuf.Timestamp from_updated_date = 13;
60
- // Get files with update date lower than set value
61
- google.protobuf.Timestamp to_updated_date = 14;
62
- // Get files with size greater than set value
63
- google.protobuf.StringValue from_size_in_bytes = 15 [(.wix.api.readOnly) = true, (.wix.api.format) = DECIMAL_VALUE, (.wix.api.decimalValue) = {maxScale: 0}];
64
- // Get files with size greater than set value
65
- google.protobuf.StringValue to_size_in_bytes = 16 [(.wix.api.readOnly) = true, (.wix.api.format) = DECIMAL_VALUE, (.wix.api.decimalValue) = {maxScale: 0}];
66
-
67
- // Term to search for. Possible terms include the value of a file's
68
- // `displayName`, `mimeType`, and `label`. <br />
69
- // For example, if a file's label is cat, the search term is 'cat'.
70
- google.protobuf.StringValue search = 17 [(.wix.api.maxLength) = 200];
71
-
72
- // Get files that were added by the provided entity
73
- IdentityInfo added_by = 18;
74
-
75
- // A list of root folders. <br />
76
- // Default: empty list will get files from all root folders.
77
- repeated RootFolder root_folders = 19 [(.wix.api.maxSize) = 3];
78
-
79
- // A list of namespaces to list files from <br/>
80
- // Default: empty list will get files from all root folders.
81
- // Note - Namespace value `Others` is not supported in this request and will produce an error
82
- repeated Namespace namespaces = 20 [(.wix.api.maxSize) = 20];
83
- // Get files with update date greater than set value
84
- google.protobuf.Timestamp from_last_used_date = 21;
85
- // Get files with update date lower than set value
86
- google.protobuf.Timestamp to_last_used_date = 22;
87
-
88
- }
89
-
90
- message ListStorageFilesResponse {
91
- // List of files in the Media Manager.
92
- repeated FileDescriptor files = 1 [(.wix.api.maxSize) = 200];
93
- // The next cursor if it exists.
94
- com.wix.media.site_media.upstream.wix.common.PagingMetadataV2 next_cursor = 2;
95
- }
96
-
97
- message GetSiteStorageRequest {
98
- }
99
-
100
- message GetSiteStorageResponse {
101
- // Information about storage
102
- message StorageDetails {
103
- // The number of files
104
- google.protobuf.Int32Value file_count = 1;
105
- // The size of the stored files in bytes
106
- google.protobuf.StringValue size_in_bytes = 2 [(.wix.api.readOnly) = true, (.wix.api.format) = DECIMAL_VALUE, (.wix.api.decimalValue) = {maxScale: 0}];
107
- // A human readable representation of the storage
108
- // google.protobuf.StringValue display_storage_string = 3;
109
- }
110
-
111
-
112
- // Storage information of a specific media type
113
- message MediaTypeStorageDetails {
114
- // The media type
115
- MediaType media_type = 1;
116
- // Storage details about the media type
117
- StorageDetails details = 2;
118
- }
119
- // Site level storage details
120
- StorageDetails total = 1;
121
- // Storage information about big files
122
- StorageDetails big_files = 2;
123
- // Trash storage details
124
- StorageDetails trash = 3;
125
-
126
- // Storage information by media types for public files
127
- repeated MediaTypeStorageDetails storage_by_media_type = 4;
128
-
129
- message QuotaInfo {
130
- // Total size of all storage files
131
- google.protobuf.StringValue size_in_bytes = 1 [(.wix.api.readOnly) = true, (.wix.api.format) = DECIMAL_VALUE, (.wix.api.decimalValue) = {maxScale: 0}];
132
- }
133
-
134
- // The last date the storage information was calculated
135
- google.protobuf.Timestamp updated_date = 6 [(.wix.api.readOnly) = true];
136
-
137
- // The quota details
138
- .wix.media.quota.v1.TotalQuota quota = 7 ;
139
- // The user id of the site owner - use this id to identify files uploaded by the current site owner
140
- IdentityInfo site_owner_info = 8;
141
- }
142
-
143
- service StorageService {
144
- option (.wix.api.service_maturity) = BETA;
145
- option (.wix.api.service_exposure) = INTERNAL;
146
- option (.wix.api.service_entity).message = "com.wix.media.site_media.v1.StorageInfo";
147
-
148
-
149
- // Retrieves a list of files in the Media Manager.
150
- //
151
- // To retrieve a list of files from all the folders in the Media Manager
152
- rpc ListStorageFiles (ListStorageFilesRequest) returns (ListStorageFilesResponse){
153
- option (google.api.http) = {get: "/v1/storage/files"};
154
- option (.wix.api.permission).name = "MEDIA.SITE_MEDIA_FILES_LIST";
155
-
156
- // The filter media type is not supported
157
- option (.wix.api.custom_validation_error) = {
158
- rule_name: "UNSUPPORTED_MEDIA_TYPE"
159
- data: "com.wix.media.site_media.v1.UnsupportedRequestValueError"
160
- };
161
- // Sort value is not supported
162
- option (.wix.api.custom_validation_error) = {
163
- rule_name: "UNSUPPORTED_SORT_VALUE"
164
- data: "com.wix.media.site_media.v1.UnsupportedRequestValueError"
165
- };
166
- // cannot add CRUD annotations because we don't use a query object
167
- }
168
-
169
- // Get information about the site storage
170
- rpc GetSiteStorage (GetSiteStorageRequest) returns (GetSiteStorageResponse) {
171
- option (.wix.api.permission).name = "MEDIA.SITE_MEDIA_STORAGE_READ";
172
- option (.wix.api.exposure) = INTERNAL;
173
- option (google.api.http) = {
174
- get : "/v1/storage/storage-info"
175
- };
176
- }
177
-
178
-
179
- }
@@ -1,9 +0,0 @@
1
- syntax = "proto3";
2
-
3
- package com.wix.media.site_media.v1;
4
-
5
- enum UploadProtocol {
6
-
7
- // The upload protocol to use for implementing the resumable upload.
8
- TUS = 0;
9
- }
@@ -1,33 +0,0 @@
1
- syntax = "proto2";
2
-
3
- package wix.api;
4
-
5
- import "google/protobuf/descriptor.proto";
6
-
7
- option java_multiple_files = true;
8
- option java_outer_classname = "ActionPayloadProto";
9
- option java_package = "com.wix.api";
10
-
11
- /*
12
- action_payload option is used to configure custom slugs for the payload type of a DomainEvent Action:
13
- service BlooperService {
14
- option (wix.api.service_entity).message = "com.wixpress.examples.Blooper"; //the "main" entity
15
- rpc MissedBlooper (MissedBlooperRequest) returns (MissedBlooperResponse) {
16
- option (wix.api.callback) = {
17
- event_type: Action
18
- payload: "com.wixpress.examples.BlooperWasMissed"
19
- };
20
- };
21
- }
22
- message BlooperWasMissed {
23
- option (wix.api.action_payload).custom_slug = "super_custom_slug"; // only define if the default slug value (snake case of the message name) is out of the question
24
- int32 how_funny_it_could_have_been = 1;
25
- }
26
- */
27
- extend google.protobuf.MessageOptions {
28
- optional ActionPayload action_payload = 50600;
29
- }
30
-
31
- message ActionPayload {
32
- optional string custom_slug = 1;
33
- }
@@ -1,393 +0,0 @@
1
- syntax = "proto2";
2
-
3
- package wix.api;
4
-
5
- import "google/protobuf/descriptor.proto";
6
-
7
- option java_multiple_files = true;
8
- option java_outer_classname = "AnnotationsProto";
9
- option java_package = "com.wix.api";
10
-
11
- extend google.protobuf.ServiceOptions {
12
- optional Maturity service_maturity = 50104;
13
- optional Exposure service_exposure = 50105;
14
- optional Deprecated service_deprecated = 50140; // mark a service as deprecated, optionally place replacing asset
15
- repeated ServiceAppendix appendix_files = 50150; // declare external configuration info
16
- }
17
-
18
- extend google.protobuf.MethodOptions {
19
- optional Exposure exposure = 50101;
20
- optional Maturity maturity = 50102;
21
- optional CacheSettings cacheable = 50103; // mark a method as cacheable, optionally pass max cache age
22
- optional Deprecated deprecated = 50141; // mark a method as deprecated, optionally place replacing asset
23
- optional Crud crud = 50146; // mark crud method type and describe related information about this method
24
- optional bool accepts_linguist = 50148; // marks that this method accepts `x-wix-linguist` header, MAY return translated/localized responses. without this option, requests that assign this header will get an error. CRUD annotated methods assumed to have this enabled for read ops and disabled for write ops.
25
- }
26
-
27
- extend google.protobuf.MessageOptions {
28
- optional string decomposite_of = 50120; // mark it a shard of a message to remove fields
29
- repeated FieldSet decomposition_minimum_fields = 50121; // constrain that sharding at the definition
30
- optional bool unwrap_array_value = 50122; // mark message as wrapper for arrays
31
- optional Deprecated message_deprecated = 50142; // mark a message as deprecated, optionally place replacing asset
32
- repeated Unique unique = 50145; // mark unique identifiers for this message
33
- }
34
-
35
- extend google.protobuf.FieldOptions {
36
- optional Exposure field_exposure = 50106;
37
- optional Maturity field_maturity = 50107;
38
- optional bool pii = 50110; // Mark specific field as PII so clients that store the data know it should be encrypted
39
- optional string referenced_entity = 50111; // FQDN of foreign keys. For example, an Order message that points to Product message can use it like this: `string product_id = 10 [(wix.api.referenced_entity) = "wix.stores.catalog.v1.product"];`
40
- optional ReferenceEntityField referenced_entity_field = 50112; // FQDN and path of a field that is referenced by `referenced_entity`. Should be located at same level or in a nested message with relation to `wix.api.referenced_entity`.
41
- optional Deprecated field_deprecated = 50143; // Mark a field as deprecated, optionally place replacing asset
42
- optional Translatable translatable = 50144; // Mark this field as translatable using MultiLingual services
43
- optional string sample_data = 50149; // Example of data that may be assigned as a value of this field
44
- optional Conditional conditional = 50151; // Configure the conditions required for this field to be returned
45
- optional bool nullable = 50152; // Mark specific field as nullable
46
- }
47
-
48
- extend google.protobuf.EnumValueOptions {
49
- optional Maturity enum_maturity = 50130;
50
- optional Exposure enum_exposure = 50131;
51
- }
52
-
53
- message ReferenceEntityField {
54
- required string path = 1; // field path from root of a message annotated with `wix.api.entity` annotation. For example 'item.name'.
55
- }
56
-
57
- message CacheSettings {
58
- optional int32 max_age_seconds = 1; // default is 604800 seconds = 1 week
59
- optional bool manual = 2; // default is false
60
- }
61
-
62
- message FieldSet {
63
- repeated string field = 1;
64
- }
65
-
66
- message Deprecated {
67
- optional string replaced_by = 1; // use relative proto FQN as absolute identifier. e.g. "wix.common.Query"
68
- optional string target_removal_date = 2; // a human readable sunset date of the deprecated resource YYYY-MM-DD
69
- }
70
-
71
- message Unique {
72
- repeated string field = 1;
73
- }
74
-
75
- message Crud {
76
- enum Method {
77
- UNKNOWN_METHOD = 0;
78
- CREATE = 1;
79
- GET_ITEM = 2;
80
- UPDATE = 3;
81
- DELETE = 4;
82
- UPSERT = 12;
83
- LIST = 5;
84
- QUERY = 6;
85
- SEARCH = 18;
86
- BULK_CREATE = 7;
87
- BULK_UPDATE = 8;
88
- BULK_UPDATE_BY_FILTER = 9;
89
- BULK_DELETE = 10;
90
- BULK_DELETE_BY_FILTER = 11;
91
- BULK_UPSERT = 13;
92
- LIST_DELETED = 14;
93
- GET_DELETED = 15;
94
- RESTORE_FROM_TRASHBIN = 16;
95
- REMOVE_FROM_TRASHBIN = 17;
96
- COUNT = 19;
97
- SEARCH_RELATED = 20;
98
- UPDATE_EXTENDED_FIELDS = 21;
99
- BULK_UPDATE_TAGS = 22;
100
- BULK_UPDATE_TAGS_BY_FILTER = 23;
101
- CUSTOM_ACTION = 24;
102
- }
103
- required Method method = 1; // method type
104
- oneof method_options {
105
- CreateMethodOptions create_options = 3;
106
- GetItemMethodOptions get_options = 4;
107
- UpdateMethodOptions update_options = 5;
108
- DeleteMethodOptions delete_options = 6;
109
- ListMethodOptions list_options = 7;
110
- QueryMethodOptions query_options = 8;
111
- SearchMethodOptions search_options = 20;
112
- BulkCreateMethodOptions bulk_create_options = 9;
113
- BulkUpdateMethodOptions bulk_update_options = 10;
114
- BulkUpdateByFilterMethodOptions bulk_update_by_filter_options = 11;
115
- BulkDeleteMethodOptions bulk_delete_options = 12;
116
- BulkDeleteByFilterMethodOptions bulk_delete_by_filter_options = 13;
117
- UpsertMethodOptions upsert_options = 14;
118
- BulkUpsertMethodOptions bulk_upsert_options = 15;
119
- ListDeletedMethodOptions list_deleted_options = 16;
120
- GetDeletedMethodOptions get_deleted_options = 17;
121
- RestoreFromTrashbinMethodOptions restore_from_trashbin_options = 18;
122
- RemoveFromTrashbinMethodOptions remove_from_trashbin_options = 19;
123
- CountOptions count_options = 21;
124
- SearchRelatedOptions search_related_options = 22;
125
- UpdateExtendedFieldsOptions update_extended_fields_options = 23;
126
- CustomActionOptions custom_action_options = 24; // marks that this method is a custom-action, that unfolds a read/write operation
127
- }
128
- }
129
-
130
- message Paging {
131
- enum Type {
132
- UNKNOWN_TYPE = 0;
133
- OFFSET = 1;
134
- CURSOR = 2;
135
- }
136
- optional Type type = 1; // paging type
137
- optional string paging_metadata_field = 2; // paging field name in response object. default is `metadata`
138
- }
139
-
140
- message CustomActionOptions {
141
- optional bool read_operation = 1; // the custom-action's operation will do nothing but read data.
142
- }
143
-
144
- message CreateMethodOptions {
145
- optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
146
- }
147
-
148
- message GetItemMethodOptions {
149
- optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
150
- optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
151
- }
152
-
153
- message UpdateMethodOptions {
154
- optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
155
- optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
156
- }
157
-
158
- message UpsertMethodOptions {
159
- optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
160
- optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
161
- }
162
-
163
- message DeleteMethodOptions {
164
- optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
165
- }
166
-
167
- message ListMethodOptions {
168
- optional string ids_field = 1; // ids field name in request object if such exists. recommended field-name: `<entity-name>_ids`
169
- required string items_field = 3; // items field name in response object.
170
- optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
171
- repeated string me_aliasable_field = 4; // collection of FQNs of fields that MAY be aliased with the const `"me"`
172
- }
173
-
174
- message QueryMethodOptions {
175
- optional string query_field = 1; // query field name in request object. default is `query`
176
- required string items_field = 3; // items field name in response object.
177
- optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
178
- oneof wql_options {
179
- // mark fields that are available for filtering and sorting via WixQueryLanguage
180
- // Deprecated - use wql annotation on the entity level
181
- Wql wql = 4 [deprecated = true];
182
- string query_options_name = 6; //Name of WQL variant to use
183
- }
184
- repeated string me_aliasable_field = 5; // collection of FQNs of fields that MAY be aliased with the const `"me"`
185
- }
186
-
187
- message SearchMethodOptions {
188
- optional string search_field = 1; // search field name in request object. default is `search`
189
- required string items_field = 3; // items field name in response object.
190
- optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
191
- oneof wql_options {
192
- Wql wql = 4; // mark fields that are available for filtering and sorting via WixQueryLanguage
193
- string query_options_name = 7; //Name of WQL variant to use
194
- }
195
- repeated string me_aliasable_field = 5; // collection of FQNs of fields that MAY be aliased with the const `"me"`
196
- repeated Search search = 6; // mark fields that are available for search
197
- }
198
-
199
- message BulkCreateMethodOptions {
200
- optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
201
- }
202
-
203
- message BulkUpdateMethodOptions {
204
- optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
205
- optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
206
- }
207
-
208
- message BulkUpdateByFilterMethodOptions {
209
- optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
210
- optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
211
- optional string filter_field = 3; // filter field name in request object. default is `filter`
212
- optional string query_options_name = 4; //Name of WQL variant to use
213
- }
214
-
215
- message BulkUpsertMethodOptions {
216
- optional string item_field = 1; // item field name in request and response objects. default is `<entity-name>`
217
- optional string fieldmask_field = 2; // fieldmask field name in request object. default is `fieldmask`, only if it really exists in model
218
- }
219
-
220
- message BulkDeleteMethodOptions {
221
- optional string ids_field = 1; // ids field name in request object. default is `<entity-name>_ids`
222
- }
223
-
224
- message BulkDeleteByFilterMethodOptions {
225
- optional string filter_field = 1; // filter field name in request object. default is `filter`
226
- optional string query_options_name = 2; //Name of WQL variant to use
227
- }
228
-
229
- message ListDeletedMethodOptions {
230
- optional string ids_field = 1; // ids field name in request object if such exists. recommended field-name: `<entity-name>_ids`
231
- required string items_field = 3; // items field name in response object.
232
- optional Paging paging = 2; // present paging mechanism info, default will be of type=`CURSOR`
233
- repeated string me_aliasable_field = 4; // collection of FQNs of fields that MAY be aliased with the const `"me"`
234
- }
235
-
236
- message GetDeletedMethodOptions {
237
- optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
238
- optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
239
- }
240
-
241
- message RestoreFromTrashbinMethodOptions {
242
- optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
243
- optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
244
- }
245
-
246
- message RemoveFromTrashbinMethodOptions {
247
- optional string id_field = 1; // id field name in request object. default is `<entity-name>_id`
248
- }
249
-
250
- message CountOptions {
251
- oneof wql_options {
252
- // The name of the endpoint that the count "copy" the WQL settings from - e.g inherit_wql_from: 'QueryProducts'
253
- // Usually, that will be the query endpoint since you want the same filter capabilities for query and count
254
- string inherit_wql_from = 1 [deprecated = true];
255
-
256
- string query_options_name = 2; //Name of WQL variant to use
257
- }
258
- }
259
-
260
- message SearchRelatedOptions {
261
- oneof wql_options {
262
- // The name of the endpoint that the related-search "copy" the WQL settings from - e.g inherit_wql_from: 'SearchProducts'
263
- // Usually, that will be the search endpoint since you want the same filter capabilities for search and related search
264
- string inherit_wql_from = 1 [deprecated = true];
265
-
266
- string query_options_name = 2; //Name of WQL variant to use
267
- }
268
- }
269
-
270
- message UpdateExtendedFieldsOptions {
271
- optional string item_field = 2; // item field name in response object only. default is `<entity-name>`
272
- }
273
-
274
- message Wql {
275
- enum Operator {
276
- option allow_alias = true;
277
- ALL_APPLICABLE_OPERATORS = 0; // Applicable by type. i.e. if we allow LT/GT for **, it means for numeric fields only.
278
- EQ = 1; // [Comparison] Matches values that are equal to a specified value.
279
- GT = 2; // [Comparison] Matches values that are greater than a specified value.
280
- GTE = 3; // [Comparison] Matches values that are greater than or equal to a specified value.
281
- IN = 4; // [Comparison] Matches any of the values specified in an array.
282
- LT = 5; // [Comparison] Matches values that are less than a specified value.
283
- LTE = 6; // [Comparison] Matches values that are less than or equal to a specified value.
284
- NE = 7; // [Comparison] Matches all values that are not equal to a specified value.
285
- NIN = 8; // [Comparison] Matches none of the values specified in an array.
286
- BEGINS = 9; // [Comparison] Matches strings that begin with a specified value (NOT case sensitive).
287
- EXISTS = 10; // [Element] Matches documents that have the specified field.
288
- HAS_ALL = 11; // [Array] Matches arrays that contain all elements specified in the query.
289
- ALL = 11 [deprecated = true]; // [Array] Matches arrays that contain all elements specified in the query.
290
- HAS_SOME = 12; // [Array] Matches arrays that contain at least one element specified in the query.
291
- ANY = 12 [deprecated = true]; // [Array] Matches arrays that contain at least one element specified in the query.
292
- EMPTY = 13; // [Array] Matches arrays that contain no elements.
293
- MATCH_ALL = 14; // Matches all items. Intended for expressing intent in selecting everything for ex. destructive operations - bulk deletes, updates, etc.
294
- MATCH_ITEMS = 16; // [Array] match multiple fields within array with AND operator semantics.
295
- }
296
- enum Sort {
297
- NONE = 0; // no sorting enabled
298
- ASC = 1; // ascending sort is supported
299
- DESC = 2; // descending sort is supported
300
- BOTH = 3; // sort is supported in both directions
301
- }
302
- message RequiredFields {
303
- // this field is deprecated because we need sort direction alongside to field path
304
- repeated string field = 1[(.wix.api.field_deprecated) = {
305
- replaced_by: "required_field"
306
- target_removal_date: "2023-03-31"
307
- }];
308
- message RequiredField {
309
- required string path = 1; // a field path that that accepts this operator
310
- optional Sort sort = 2; // sort type enabled for this glob
311
- }
312
- repeated RequiredField required_field = 2; // all required field configurations to satisfy composite index
313
- }
314
- message OperatorFieldSupport {
315
- repeated Operator operator = 1; // Operators supported for fields that match the glob
316
- // this field is deprecated because glob is hard to read. moved to a direct field config approach
317
- optional string glob = 2 [(.wix.api.field_deprecated) = {
318
- replaced_by: "field"
319
- target_removal_date: "2023-03-31"
320
- }, deprecated = true];
321
- repeated string field = 5; // a collection of field paths that that accepts this operator
322
- optional Sort sort = 3; // sort type enabled for this glob
323
- repeated RequiredFields required_fields = 4; // fields that match this glob, can be used only if the query is also filtered by required_fields
324
- optional Maturity maturity = 6;
325
- }
326
- // this field is deprecated due to a better and shorter naming
327
- repeated OperatorFieldSupport operator_field_support = 3 [(.wix.api.field_deprecated) = {
328
- replaced_by: "pattern"
329
- target_removal_date: "2023-03-31"
330
- }, deprecated = true];
331
- repeated OperatorFieldSupport pattern = 4; // supported operators for subject query method
332
- optional bool validate_query = 6; // false by default. all new services will have it set to true
333
- }
334
-
335
- message Search {
336
- repeated string field = 1; // a collection of field paths that supports Free Text Search
337
- optional Maturity maturity = 2;
338
- }
339
-
340
- message Translatable {
341
- enum Type {
342
- UNDEFINED_TYPE = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
343
- SHORT_TEXT = 1;
344
- LONG_TEXT = 2;
345
- RICH_TEXT = 3;
346
- RICH_CONTENT_EDITOR = 4;
347
- SELECTION = 5;
348
- MULTI_SELECTION = 6;
349
- DOCUMENT = 7;
350
- IMAGE = 8;
351
- VIDEO = 9;
352
- IMAGE_LINK = 10; // Image URI without metadata
353
- }
354
- optional string name = 1; // a human friendly field name
355
- optional bool hidden = 2; // is this translatable field hidden in Multilingual
356
- optional string grouping = 3; // fields in schema may be grouped under meaningful topic or category of the source entity
357
- required Type type = 4; // translation input component type e.g. "freetext", "dropdown", etc..
358
- optional bool display_only = 5; // is this field for preview and not translatable
359
- }
360
-
361
- message Conditional {
362
- optional string permission = 1; // field will not be returned by the server, unless the client has this permission. If `requested_field` is also set, and a client explicitly requests this field but does not have permission, server will return 403-Forbidden error
363
- optional string requested_field = 2; // field will not be returned by the server, unless the client explicitly requested it using `fields` parameter in the request, with the enum value specified by this annotation
364
- }
365
-
366
- message ServiceAppendix {
367
- enum Type {
368
- UNKNOWN_APPENDIX_TYPE = 0;
369
- NILE = 1; // Nile(tm) FW configuration
370
- MESSAGE_BUS = 2; // wix message bus / pub-sub configuration
371
- }
372
- required Type type = 1; // appendix type
373
- required string path = 2; // absolute from module root
374
- }
375
-
376
- // Defines the target audience of your API
377
- // @see https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/api-lifecycle/2005-exposure
378
- enum Exposure {
379
- // Exposed to the owning team only. No other devs inside or outside Wix can use these APIs.
380
- PRIVATE = 0;
381
- // Exposed to internal Wix devs only. APIs that can only accept gRPC traffic and/or HTTP traffic over VPN
382
- INTERNAL = 1;
383
- // Exposed (or intended to be) to external devs. APIs that are accessible from the Internet, for example to the dashboard or live-site.
384
- PUBLIC = 2;
385
- }
386
-
387
- enum Maturity {
388
- ALPHA = 0;
389
- BETA = 1;
390
- IA = 2 [deprecated=true];
391
- GA = 3;
392
- NOT_IMPLEMENTED = 4;
393
- }