@mittwald/api-client 4.300.0 → 4.302.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.
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.299.0';
1
+ export const MittwaldAPIClientVersion = '4.301.0';
@@ -8003,6 +8003,8 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
8003
8003
  [x: string]: unknown;
8004
8004
  }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
8005
8005
  [x: string]: unknown;
8006
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
8007
+ [x: string]: unknown;
8006
8008
  }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
8007
8009
  [x: string]: unknown;
8008
8010
  }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
@@ -8025,6 +8027,8 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
8025
8027
  [x: string]: unknown;
8026
8028
  }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
8027
8029
  [x: string]: unknown;
8030
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
8031
+ [x: string]: unknown;
8028
8032
  }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
8029
8033
  [x: string]: unknown;
8030
8034
  }, 429, "application/json">>>;
@@ -16757,6 +16761,8 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
16757
16761
  [x: string]: unknown;
16758
16762
  }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
16759
16763
  [x: string]: unknown;
16764
+ }, 409, "application/json"> | import("@mittwald/api-client-commons").Response<{
16765
+ [x: string]: unknown;
16760
16766
  }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
16761
16767
  data: {
16762
16768
  name: string;
@@ -16778,6 +16784,8 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
16778
16784
  [x: string]: unknown;
16779
16785
  }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
16780
16786
  [x: string]: unknown;
16787
+ }, 409, "application/json"> | import("@mittwald/api-client-commons").Response<{
16788
+ [x: string]: unknown;
16781
16789
  }, 429, "application/json">>>;
16782
16790
  /** Get a DNSZone. */
16783
16791
  dnsGetDnsZone: (request: {
@@ -210,7 +210,7 @@ export declare const contributorUpdateBillingInformation: OpenAPIOperation<Reque
210
210
  /** Get the Stripe Billing Portal Link for a Customer */
211
211
  export declare const contributorGetCustomerBillingPortalLink: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdBillingPortal.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdBillingPortal.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdBillingPortal.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdBillingPortal.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdBillingPortal.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdBillingPortal.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdBillingPortal.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdBillingPortal.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
212
212
  /** Get the Stripe Dashboard Link for a Contributor. */
213
- export declare const contributorGetLoginLink: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
213
+ export declare const contributorGetLoginLink: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdDashboard.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
214
214
  /** List ContractPartners of the contributor. */
215
215
  export declare const contributorListContractPartnersOfContributor: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdContractPartners.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdContractPartners.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdContractPartners.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdContractPartners.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdContractPartners.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdContractPartners.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
216
216
  /** List incoming Invoices of a Contributor. */
@@ -398,7 +398,7 @@ export declare const newsletterSubscribeUser: OpenAPIOperation<RequestType<Simpl
398
398
  /** Update your account information. */
399
399
  export declare const userUpdateAccount: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2UsersSelfPersonalInformation.Put.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2UsersSelfPersonalInformation.Put.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2UsersSelfPersonalInformation.Put.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2UsersSelfPersonalInformation.Put.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2UsersSelfPersonalInformation.Put.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2UsersSelfPersonalInformation.Put.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2UsersSelfPersonalInformation.Put.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2UsersSelfPersonalInformation.Put.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
400
400
  /** Create a DNSZone. */
401
- export declare const dnsCreateDnsZone: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Responses.$201.Content.ApplicationJson>, 201, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
401
+ export declare const dnsCreateDnsZone: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Responses.$201.Content.ApplicationJson>, 201, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Responses.$409.Content.ApplicationJson>, 409, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZones.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
402
402
  /** Get a DNSZone. */
403
403
  export declare const dnsGetDnsZone: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2DnsZonesDnsZoneId.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2DnsZonesDnsZoneId.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2DnsZonesDnsZoneId.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2DnsZonesDnsZoneId.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZonesDnsZoneId.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZonesDnsZoneId.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2DnsZonesDnsZoneId.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
404
404
  /** Delete a DNSZone. */
@@ -3097,21 +3097,56 @@ export declare namespace MittwaldAPIV2 {
3097
3097
  }
3098
3098
  interface DatabaseCreateMySqlDatabase {
3099
3099
  characterSettings?: MittwaldAPIV2.Components.Schemas.DatabaseCharacterSettings;
3100
+ /**
3101
+ * A description of the MySQLDatabase. This is for your own reference and has no effect on the database itself.
3102
+ *
3103
+ */
3100
3104
  description: string;
3101
3105
  projectId: string;
3106
+ /**
3107
+ * The MySQL version to use for this database, in `<major>.<minor>` format. Use the `GET /v2/mysql-versions` endpoint to query available versions.
3108
+ *
3109
+ */
3102
3110
  version: string;
3103
3111
  }
3104
3112
  interface DatabaseCreateMySqlUser {
3113
+ /**
3114
+ * An IP range (in CIDR notation) for which access should be allowed.
3115
+ */
3105
3116
  accessIpMask?: string;
3117
+ /**
3118
+ * The access level that this MySQLUser should have for the database. The `full` access level grants the user read/write privileges on the database.
3119
+ *
3120
+ */
3106
3121
  accessLevel: "full" | "readonly";
3107
3122
  databaseId: string;
3108
3123
  description: string;
3124
+ /**
3125
+ * Describes if users should be able to connection to this database from external
3126
+ * sources. Defaults to `false` when not set.
3127
+ *
3128
+ * To find out how to connect to your database from external sources, refer to the `externalHostname` field of the `GET /v2/mysql-databases/{id}` endpoint.
3129
+ *
3130
+ */
3109
3131
  externalAccess?: boolean;
3110
3132
  password: string;
3111
3133
  }
3112
3134
  interface DatabaseCreateMySqlUserWithDatabase {
3113
3135
  accessIpMask?: string;
3136
+ /**
3137
+ * The access level that this MySQLUser should have for the database. The `full` access level grants the user read/write privileges on the database.
3138
+ *
3139
+ * For MySQLUsers that are created in the same step as the database itself, `full` is the only available option.
3140
+ *
3141
+ */
3114
3142
  accessLevel: "full";
3143
+ /**
3144
+ * Describes if users should be able to connection to this database from external
3145
+ * sources. Defaults to `false` when not set.
3146
+ *
3147
+ * To find out how to connect to your database from external sources, refer to the `externalHostname` field of the `GET /v2/mysql-databases/{id}` endpoint.
3148
+ *
3149
+ */
3115
3150
  externalAccess?: boolean;
3116
3151
  password: string;
3117
3152
  }
@@ -3123,20 +3158,46 @@ export declare namespace MittwaldAPIV2 {
3123
3158
  versionId: string;
3124
3159
  }
3125
3160
  interface DatabaseCharacterSettings {
3161
+ /**
3162
+ * A valid MySQL character set. Refer to https://dev.mysql.com/doc/refman/8.4/en/charset-mysql.html for more information and available character sets.
3163
+ *
3164
+ */
3126
3165
  characterSet: string;
3166
+ /**
3167
+ * A valid MySQL collation. Refer to https://dev.mysql.com/doc/refman/8.4/en/charset-mysql.html for more information and available collations.
3168
+ *
3169
+ */
3127
3170
  collation: string;
3128
3171
  }
3129
3172
  interface DatabaseMySqlDatabase {
3130
3173
  characterSettings: MittwaldAPIV2.Components.Schemas.DatabaseCharacterSettings;
3131
3174
  createdAt: string;
3175
+ /**
3176
+ * A description of the MySQLDatabase. This is for your own reference and has no effect on the database itself.
3177
+ *
3178
+ */
3132
3179
  description: string;
3180
+ /**
3181
+ * The hostname that you can use to connect to this MySQLDatabase from external sources, like your local machine or services running outside the mittwald cloud platform.
3182
+ *
3183
+ * Note that you still need a database user with `externalAccess` enabled to connect via this hostname.
3184
+ *
3185
+ */
3133
3186
  externalHostname: string;
3134
3187
  finalizers?: string[];
3188
+ /**
3189
+ * The hostname that you can use to connect to this MySQLDatabase from _within_ the hosting environment.
3190
+ *
3191
+ */
3135
3192
  hostname: string;
3136
3193
  id: string;
3137
3194
  isReady: boolean;
3138
3195
  isShared: boolean;
3139
3196
  mainUser?: MittwaldAPIV2.Components.Schemas.DatabaseMySqlUser;
3197
+ /**
3198
+ * The name of the MySQLDatabase. This is also the name of the database that you can use when connecting to it. It is automatically generated and cannot be changed.
3199
+ *
3200
+ */
3140
3201
  name: string;
3141
3202
  projectId: string;
3142
3203
  status: MittwaldAPIV2.Components.Schemas.DatabaseDatabaseStatus;
@@ -3144,6 +3205,10 @@ export declare namespace MittwaldAPIV2 {
3144
3205
  storageUsageInBytes: number;
3145
3206
  storageUsageInBytesSetAt: string;
3146
3207
  updatedAt: string;
3208
+ /**
3209
+ * The MySQL version that this database is running, in `<major>.<minor>` format. Use the `GET /v2/mysql-versions` endpoint to query available versions.
3210
+ *
3211
+ */
3147
3212
  version: string;
3148
3213
  }
3149
3214
  interface DatabasePhpMyAdminURL {
@@ -11333,6 +11398,13 @@ export declare namespace MittwaldAPIV2 {
11333
11398
  }
11334
11399
  }
11335
11400
  }
11401
+ namespace $403 {
11402
+ namespace Content {
11403
+ interface ApplicationJson {
11404
+ [k: string]: unknown;
11405
+ }
11406
+ }
11407
+ }
11336
11408
  namespace $404 {
11337
11409
  namespace Content {
11338
11410
  interface ApplicationJson {
@@ -16130,6 +16202,13 @@ export declare namespace MittwaldAPIV2 {
16130
16202
  }
16131
16203
  }
16132
16204
  }
16205
+ namespace $409 {
16206
+ namespace Content {
16207
+ interface ApplicationJson {
16208
+ [k: string]: unknown;
16209
+ }
16210
+ }
16211
+ }
16133
16212
  namespace $429 {
16134
16213
  namespace Content {
16135
16214
  interface ApplicationJson {
@@ -1 +1 @@
1
- export declare const MittwaldAPIClientVersion = '4.299.0';
1
+ export declare const MittwaldAPIClientVersion = '4.301.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "4.300.0",
3
+ "version": "4.302.0",
4
4
  "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
5
5
  "type": "module",
6
6
  "description": "Auto-generated client for the mittwald API",
@@ -46,11 +46,11 @@
46
46
  "test:compile": "run tsc --noEmit"
47
47
  },
48
48
  "dependencies": {
49
- "@mittwald/api-client-commons": "^4.300.0",
49
+ "@mittwald/api-client-commons": "^4.302.0",
50
50
  "browser-or-node": "^3.0.0"
51
51
  },
52
52
  "devDependencies": {
53
- "@mittwald/api-code-generator": "^4.300.0",
53
+ "@mittwald/api-code-generator": "^4.302.0",
54
54
  "@mittwald/react-use-promise": "^2.6.2",
55
55
  "@types/node": "^22.18.11",
56
56
  "@types/react": "^18.3.26",
@@ -80,5 +80,5 @@
80
80
  "optional": true
81
81
  }
82
82
  },
83
- "gitHead": "92babd88c48ecb75b0e5bbf9ccf0d0395f42ad15"
83
+ "gitHead": "e1d58c9d9f86ee7752a2f26521744e9e21eeafee"
84
84
  }