@mittwald/api-client 4.299.0 → 4.301.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.
- package/dist/esm/version.js +1 -1
- package/dist/types/generated/v2/client-react.d.ts +1 -0
- package/dist/types/generated/v2/client.d.ts +6 -0
- package/dist/types/generated/v2/descriptors.d.ts +1 -1
- package/dist/types/generated/v2/types.d.ts +76 -0
- package/dist/types/version.d.ts +1 -1
- package/package.json +4 -4
package/dist/esm/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const MittwaldAPIClientVersion = '4.
|
|
1
|
+
export const MittwaldAPIClientVersion = '4.300.0';
|
|
@@ -126,6 +126,7 @@ declare const buildAppApi: (baseClient: MittwaldAPIV2Client) => {
|
|
|
126
126
|
disabled: boolean;
|
|
127
127
|
id: string;
|
|
128
128
|
installationPath: string;
|
|
129
|
+
lastError?: string | undefined;
|
|
129
130
|
linkedDatabases: import("./types.js").MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[];
|
|
130
131
|
lockedBy?: {
|
|
131
132
|
[k: string]: import("./types.js").MittwaldAPIV2.Components.Schemas.AppLockPurpose;
|
|
@@ -932,6 +932,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
932
932
|
disabled: boolean;
|
|
933
933
|
id: string;
|
|
934
934
|
installationPath: string;
|
|
935
|
+
lastError?: string | undefined;
|
|
935
936
|
linkedDatabases: import("./types.js").MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[];
|
|
936
937
|
lockedBy?: {
|
|
937
938
|
[k: string]: import("./types.js").MittwaldAPIV2.Components.Schemas.AppLockPurpose;
|
|
@@ -972,6 +973,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
972
973
|
disabled: boolean;
|
|
973
974
|
id: string;
|
|
974
975
|
installationPath: string;
|
|
976
|
+
lastError?: string | undefined;
|
|
975
977
|
linkedDatabases: import("./types.js").MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[];
|
|
976
978
|
lockedBy?: {
|
|
977
979
|
[k: string]: import("./types.js").MittwaldAPIV2.Components.Schemas.AppLockPurpose;
|
|
@@ -8001,6 +8003,8 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
8001
8003
|
[x: string]: unknown;
|
|
8002
8004
|
}, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
8003
8005
|
[x: string]: unknown;
|
|
8006
|
+
}, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
8007
|
+
[x: string]: unknown;
|
|
8004
8008
|
}, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
8005
8009
|
[x: string]: unknown;
|
|
8006
8010
|
}, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
|
|
@@ -8023,6 +8027,8 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
|
|
|
8023
8027
|
[x: string]: unknown;
|
|
8024
8028
|
}, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
8025
8029
|
[x: string]: unknown;
|
|
8030
|
+
}, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
8031
|
+
[x: string]: unknown;
|
|
8026
8032
|
}, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
|
|
8027
8033
|
[x: string]: unknown;
|
|
8028
8034
|
}, 429, "application/json">>>;
|
|
@@ -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. */
|
|
@@ -1941,6 +1941,10 @@ export declare namespace MittwaldAPIV2 {
|
|
|
1941
1941
|
disabled: boolean;
|
|
1942
1942
|
id: string;
|
|
1943
1943
|
installationPath: string;
|
|
1944
|
+
/**
|
|
1945
|
+
* The last error that occurred during an update. Resets on success.
|
|
1946
|
+
*/
|
|
1947
|
+
lastError?: string;
|
|
1944
1948
|
linkedDatabases: MittwaldAPIV2.Components.Schemas.AppLinkedDatabase[];
|
|
1945
1949
|
lockedBy?: {
|
|
1946
1950
|
[k: string]: MittwaldAPIV2.Components.Schemas.AppLockPurpose;
|
|
@@ -3093,21 +3097,56 @@ export declare namespace MittwaldAPIV2 {
|
|
|
3093
3097
|
}
|
|
3094
3098
|
interface DatabaseCreateMySqlDatabase {
|
|
3095
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
|
+
*/
|
|
3096
3104
|
description: string;
|
|
3097
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
|
+
*/
|
|
3098
3110
|
version: string;
|
|
3099
3111
|
}
|
|
3100
3112
|
interface DatabaseCreateMySqlUser {
|
|
3113
|
+
/**
|
|
3114
|
+
* An IP range (in CIDR notation) for which access should be allowed.
|
|
3115
|
+
*/
|
|
3101
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
|
+
*/
|
|
3102
3121
|
accessLevel: "full" | "readonly";
|
|
3103
3122
|
databaseId: string;
|
|
3104
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
|
+
*/
|
|
3105
3131
|
externalAccess?: boolean;
|
|
3106
3132
|
password: string;
|
|
3107
3133
|
}
|
|
3108
3134
|
interface DatabaseCreateMySqlUserWithDatabase {
|
|
3109
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
|
+
*/
|
|
3110
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
|
+
*/
|
|
3111
3150
|
externalAccess?: boolean;
|
|
3112
3151
|
password: string;
|
|
3113
3152
|
}
|
|
@@ -3119,20 +3158,46 @@ export declare namespace MittwaldAPIV2 {
|
|
|
3119
3158
|
versionId: string;
|
|
3120
3159
|
}
|
|
3121
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
|
+
*/
|
|
3122
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
|
+
*/
|
|
3123
3170
|
collation: string;
|
|
3124
3171
|
}
|
|
3125
3172
|
interface DatabaseMySqlDatabase {
|
|
3126
3173
|
characterSettings: MittwaldAPIV2.Components.Schemas.DatabaseCharacterSettings;
|
|
3127
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
|
+
*/
|
|
3128
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
|
+
*/
|
|
3129
3186
|
externalHostname: string;
|
|
3130
3187
|
finalizers?: string[];
|
|
3188
|
+
/**
|
|
3189
|
+
* The hostname that you can use to connect to this MySQLDatabase from _within_ the hosting environment.
|
|
3190
|
+
*
|
|
3191
|
+
*/
|
|
3131
3192
|
hostname: string;
|
|
3132
3193
|
id: string;
|
|
3133
3194
|
isReady: boolean;
|
|
3134
3195
|
isShared: boolean;
|
|
3135
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
|
+
*/
|
|
3136
3201
|
name: string;
|
|
3137
3202
|
projectId: string;
|
|
3138
3203
|
status: MittwaldAPIV2.Components.Schemas.DatabaseDatabaseStatus;
|
|
@@ -3140,6 +3205,10 @@ export declare namespace MittwaldAPIV2 {
|
|
|
3140
3205
|
storageUsageInBytes: number;
|
|
3141
3206
|
storageUsageInBytesSetAt: string;
|
|
3142
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
|
+
*/
|
|
3143
3212
|
version: string;
|
|
3144
3213
|
}
|
|
3145
3214
|
interface DatabasePhpMyAdminURL {
|
|
@@ -11329,6 +11398,13 @@ export declare namespace MittwaldAPIV2 {
|
|
|
11329
11398
|
}
|
|
11330
11399
|
}
|
|
11331
11400
|
}
|
|
11401
|
+
namespace $403 {
|
|
11402
|
+
namespace Content {
|
|
11403
|
+
interface ApplicationJson {
|
|
11404
|
+
[k: string]: unknown;
|
|
11405
|
+
}
|
|
11406
|
+
}
|
|
11407
|
+
}
|
|
11332
11408
|
namespace $404 {
|
|
11333
11409
|
namespace Content {
|
|
11334
11410
|
interface ApplicationJson {
|
package/dist/types/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const MittwaldAPIClientVersion = '4.
|
|
1
|
+
export declare const MittwaldAPIClientVersion = '4.300.0';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mittwald/api-client",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.301.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.
|
|
49
|
+
"@mittwald/api-client-commons": "^4.301.0",
|
|
50
50
|
"browser-or-node": "^3.0.0"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
|
-
"@mittwald/api-code-generator": "^4.
|
|
53
|
+
"@mittwald/api-code-generator": "^4.301.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": "
|
|
83
|
+
"gitHead": "3a26ccd86f6117e9f5c9c1a2c4100fe5a0a9193d"
|
|
84
84
|
}
|