@mittwald/api-client 3.0.21 → 3.0.23

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.
@@ -1064,16 +1064,6 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
1064
1064
  transferInAuthCode?: string | undefined;
1065
1065
  usesDefaultNameserver: boolean;
1066
1066
  }>;
1067
- /** Get a HandleSchema. */
1068
- getHandleFields: (conf: {
1069
- domainName: string;
1070
- headers?: {
1071
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1072
- } | undefined;
1073
- }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1074
- jsonSchemaAdminC?: {} | undefined;
1075
- jsonSchemaOwnerC: {};
1076
- }>;
1077
1067
  /** Get File Service Reference for a Screenshot of a domain. */
1078
1068
  getScreenshotForDomain: (conf: {
1079
1069
  data: {
@@ -1088,25 +1078,6 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
1088
1078
  }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1089
1079
  references?: string[] | undefined;
1090
1080
  }>;
1091
- /** Get a domain ownership. */
1092
- getSpecificDomainOwnership: (conf: {
1093
- domainOwnershipId: string;
1094
- headers?: {
1095
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1096
- "x-access-token"?: string | undefined;
1097
- } | undefined;
1098
- }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1099
- domain: string;
1100
- id: string;
1101
- projectId: string;
1102
- txtRecord: string;
1103
- }>;
1104
- /** List all supported top level domains. */
1105
- getSupportedTlds: (conf?: {
1106
- headers?: {
1107
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1108
- } | undefined;
1109
- } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainTopLevel[]>;
1110
1081
  /** List all domain ownerships of a project. */
1111
1082
  listDomainOwnerships: (conf: {
1112
1083
  projectId: string;
@@ -1129,6 +1100,19 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
1129
1100
  domainSearchName?: string | undefined;
1130
1101
  } | undefined;
1131
1102
  }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainDomain[]>;
1103
+ /** Get a domain ownership. */
1104
+ getSpecificDomainOwnership: (conf: {
1105
+ domainOwnershipId: string;
1106
+ headers?: {
1107
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1108
+ "x-access-token"?: string | undefined;
1109
+ } | undefined;
1110
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1111
+ domain: string;
1112
+ id: string;
1113
+ projectId: string;
1114
+ txtRecord: string;
1115
+ }>;
1132
1116
  /** Get an Ingress. */
1133
1117
  ingressGetSpecific: (conf: {
1134
1118
  ingressId: string;
@@ -1164,6 +1148,22 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
1164
1148
  "x-access-token"?: string | undefined;
1165
1149
  } | undefined;
1166
1150
  }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.IngressIngress[]>;
1151
+ /** Get a HandleSchema. */
1152
+ getHandleFields: (conf: {
1153
+ domainName: string;
1154
+ headers?: {
1155
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1156
+ } | undefined;
1157
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<{
1158
+ jsonSchemaAdminC?: {} | undefined;
1159
+ jsonSchemaOwnerC: {};
1160
+ }>;
1161
+ /** List all supported top level domains. */
1162
+ getSupportedTlds: (conf?: {
1163
+ headers?: {
1164
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1165
+ } | undefined;
1166
+ } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.DomainTopLevel[]>;
1167
1167
  };
1168
1168
  declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
1169
1169
  /** Get a File's meta. */
@@ -1234,17 +1234,25 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
1234
1234
  }) => import("@mittwald/react-use-promise/types").AsyncResource<string>;
1235
1235
  };
1236
1236
  declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
1237
- /** Get all deliveryboxes by project ID */
1238
- deliveryboxList: (conf: {
1237
+ /** List DeliveryBoxes belonging to a Project. */
1238
+ listDeliveryBoxes: (conf: {
1239
1239
  projectId: string;
1240
1240
  headers?: {
1241
1241
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1242
1242
  "x-access-token"?: string | undefined;
1243
1243
  } | undefined;
1244
1244
  }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailDeliverybox[]>;
1245
- /** Get a specific deliverybox */
1246
- deliveryboxGetSpecific: (conf: {
1247
- id: string;
1245
+ /** List MailAddresses belonging to a Project. */
1246
+ listMailAddresses: (conf: {
1247
+ projectId: string;
1248
+ headers?: {
1249
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1250
+ "x-access-token"?: string | undefined;
1251
+ } | undefined;
1252
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailMailAddress[]>;
1253
+ /** Get a DeliveryBox. */
1254
+ getDeliveryBox: (conf: {
1255
+ deliveryBoxId: string;
1248
1256
  headers?: {
1249
1257
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1250
1258
  "x-access-token"?: string | undefined;
@@ -1259,17 +1267,9 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
1259
1267
  sendingEnabled: boolean;
1260
1268
  updatedAt: string;
1261
1269
  }>;
1262
- /** Get all mail addresses for a project ID */
1263
- mailaddressList: (conf: {
1264
- projectId: string;
1265
- headers?: {
1266
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1267
- "x-access-token"?: string | undefined;
1268
- } | undefined;
1269
- }) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MailMailAddress[]>;
1270
- /** Get a specific mail address */
1271
- mailaddressGetSpecific: (conf: {
1272
- id: string;
1270
+ /** Get a MailAddress. */
1271
+ getMailAddress: (conf: {
1272
+ mailAddressId: string;
1273
1273
  headers?: {
1274
1274
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1275
1275
  "x-access-token"?: string | undefined;
@@ -1307,8 +1307,8 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
1307
1307
  receivingDisabled: boolean;
1308
1308
  updatedAt: string;
1309
1309
  }>;
1310
- /** Get settings for a given project ID */
1311
- projectsettingGetSpecific: (conf: {
1310
+ /** List mail settings of a Project. */
1311
+ listProjectMailSettings: (conf: {
1312
1312
  projectId: string;
1313
1313
  headers?: {
1314
1314
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
@@ -152,24 +152,24 @@ const buildDomainApi = (baseClient) => ({
152
152
  dnsZonesForProject: new ApiCallAsyncResourceFactory(descriptors.dnsZonesForProject, baseClient.domain.dnsZonesForProject).getApiResource,
153
153
  /** Get a Domain. */
154
154
  getDomain: new ApiCallAsyncResourceFactory(descriptors.domainGetDomain, baseClient.domain.getDomain).getApiResource,
155
- /** Get a HandleSchema. */
156
- getHandleFields: new ApiCallAsyncResourceFactory(descriptors.domainGetHandleFields, baseClient.domain.getHandleFields).getApiResource,
157
155
  /** Get File Service Reference for a Screenshot of a domain. */
158
156
  getScreenshotForDomain: new ApiCallAsyncResourceFactory(descriptors.domainGetScreenshotForDomain, baseClient.domain.getScreenshotForDomain).getApiResource,
159
- /** Get a domain ownership. */
160
- getSpecificDomainOwnership: new ApiCallAsyncResourceFactory(descriptors.domainGetSpecificDomainOwnership, baseClient.domain.getSpecificDomainOwnership).getApiResource,
161
- /** List all supported top level domains. */
162
- getSupportedTlds: new ApiCallAsyncResourceFactory(descriptors.domainGetSupportedTlds, baseClient.domain.getSupportedTlds).getApiResource,
163
157
  /** List all domain ownerships of a project. */
164
158
  listDomainOwnerships: new ApiCallAsyncResourceFactory(descriptors.domainListDomainOwnerships, baseClient.domain.listDomainOwnerships).getApiResource,
165
159
  /** List Domains belonging to a Project. */
166
160
  listDomains: new ApiCallAsyncResourceFactory(descriptors.domainListDomains, baseClient.domain.listDomains).getApiResource,
161
+ /** Get a domain ownership. */
162
+ getSpecificDomainOwnership: new ApiCallAsyncResourceFactory(descriptors.domainGetSpecificDomainOwnership, baseClient.domain.getSpecificDomainOwnership).getApiResource,
167
163
  /** Get an Ingress. */
168
164
  ingressGetSpecific: new ApiCallAsyncResourceFactory(descriptors.ingressGetSpecific, baseClient.domain.ingressGetSpecific).getApiResource,
169
165
  /** List Ingresses the user has access to. */
170
166
  ingressListAccessible: new ApiCallAsyncResourceFactory(descriptors.ingressListAccessible, baseClient.domain.ingressListAccessible).getApiResource,
171
167
  /** List Ingresses belonging to a project. */
172
168
  ingressListForProject: new ApiCallAsyncResourceFactory(descriptors.ingressListForProject, baseClient.domain.ingressListForProject).getApiResource,
169
+ /** Get a HandleSchema. */
170
+ getHandleFields: new ApiCallAsyncResourceFactory(descriptors.domainGetHandleFields, baseClient.domain.getHandleFields).getApiResource,
171
+ /** List all supported top level domains. */
172
+ getSupportedTlds: new ApiCallAsyncResourceFactory(descriptors.domainGetSupportedTlds, baseClient.domain.getSupportedTlds).getApiResource,
173
173
  });
174
174
  const buildFileApi = (baseClient) => ({
175
175
  /** Get a File's meta. */
@@ -182,16 +182,16 @@ const buildFileApi = (baseClient) => ({
182
182
  getFile: new ApiCallAsyncResourceFactory(descriptors.fileGetFile, baseClient.file.getFile).getApiResource,
183
183
  });
184
184
  const buildMailApi = (baseClient) => ({
185
- /** Get all deliveryboxes by project ID */
186
- deliveryboxList: new ApiCallAsyncResourceFactory(descriptors.mailDeliveryboxList, baseClient.mail.deliveryboxList).getApiResource,
187
- /** Get a specific deliverybox */
188
- deliveryboxGetSpecific: new ApiCallAsyncResourceFactory(descriptors.mailDeliveryboxGetSpecific, baseClient.mail.deliveryboxGetSpecific).getApiResource,
189
- /** Get all mail addresses for a project ID */
190
- mailaddressList: new ApiCallAsyncResourceFactory(descriptors.mailMailaddressList, baseClient.mail.mailaddressList).getApiResource,
191
- /** Get a specific mail address */
192
- mailaddressGetSpecific: new ApiCallAsyncResourceFactory(descriptors.mailMailaddressGetSpecific, baseClient.mail.mailaddressGetSpecific).getApiResource,
193
- /** Get settings for a given project ID */
194
- projectsettingGetSpecific: new ApiCallAsyncResourceFactory(descriptors.mailProjectsettingGetSpecific, baseClient.mail.projectsettingGetSpecific).getApiResource,
185
+ /** List DeliveryBoxes belonging to a Project. */
186
+ listDeliveryBoxes: new ApiCallAsyncResourceFactory(descriptors.mailListDeliveryBoxes, baseClient.mail.listDeliveryBoxes).getApiResource,
187
+ /** List MailAddresses belonging to a Project. */
188
+ listMailAddresses: new ApiCallAsyncResourceFactory(descriptors.mailListMailAddresses, baseClient.mail.listMailAddresses).getApiResource,
189
+ /** Get a DeliveryBox. */
190
+ getDeliveryBox: new ApiCallAsyncResourceFactory(descriptors.mailGetDeliveryBox, baseClient.mail.getDeliveryBox).getApiResource,
191
+ /** Get a MailAddress. */
192
+ getMailAddress: new ApiCallAsyncResourceFactory(descriptors.mailGetMailAddress, baseClient.mail.getMailAddress).getApiResource,
193
+ /** List mail settings of a Project. */
194
+ listProjectMailSettings: new ApiCallAsyncResourceFactory(descriptors.mailListProjectMailSettings, baseClient.mail.listProjectMailSettings).getApiResource,
195
195
  });
196
196
  const buildNotificationApi = (baseClient) => ({
197
197
  /** Getting the subscription status of the subscription. */