@mittwald/api-client 4.212.0 → 4.213.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.
@@ -890,6 +890,19 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
890
890
  }) => import("@mittwald/react-use-promise").AsyncResource<{
891
891
  url?: string | undefined;
892
892
  }>;
893
+ /** List ContractPartners of the contributor. */
894
+ contributorListContractPartnersOfContributor: (conf: {
895
+ contributorId: string;
896
+ queryParameters?: {
897
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
898
+ extensionId?: string | undefined;
899
+ extensionInstanceId?: string | undefined;
900
+ } | undefined;
901
+ headers?: {
902
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
903
+ "x-access-token"?: string | undefined;
904
+ } | undefined;
905
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContractPartner[]>;
893
906
  /** List incoming Invoices of a Contributor. */
894
907
  contributorListIncomingInvoices: (conf: {
895
908
  contributorId: string;
@@ -934,6 +947,13 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
934
947
  totalNet: number;
935
948
  webLink: string;
936
949
  }[]>;
950
+ /** Get a Contributor. */
951
+ extensionGetContributor: (conf: {
952
+ contributorId: string;
953
+ headers?: {
954
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
955
+ } | undefined;
956
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("@mittwald/api-client-commons").Simplify<import("./types.js").MittwaldAPIV2.Paths.V2ContributorsContributorId.Get.Responses.$200.Content.ApplicationJson>>;
937
957
  /** Request an Access Token for the Incoming Invoice file. */
938
958
  contributorReceiptGetFileAccessToken: (conf: {
939
959
  contributorId: string;
@@ -946,86 +966,28 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
946
966
  accessToken: string;
947
967
  expiresAt: string;
948
968
  }>;
949
- /** Get all open extension orders for given customer */
950
- extensionGetCustomerExtensionInstanceOrders: (conf: {
951
- customerId: string;
952
- headers?: {
953
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
954
- "x-access-token"?: string | undefined;
955
- } | undefined;
956
- }) => import("@mittwald/react-use-promise").AsyncResource<{
957
- extensionId?: string;
958
- }[]>;
959
- /** Get the Contract Strategy of an Extension Instance */
960
- extensionGetExtensionInstanceContract: (conf: {
961
- extensionInstanceId: string;
962
- headers?: {
963
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
964
- "x-access-token"?: string | undefined;
965
- } | undefined;
966
- }) => import("@mittwald/react-use-promise").AsyncResource<{
967
- currentPrice?: number | undefined;
968
- interactionDeadline?: string | undefined;
969
- interactionRequired: boolean;
970
- status: "notStarted" | "pending" | "active" | "terminationPending";
971
- terminationTargetDate?: string | undefined;
972
- }>;
973
- /** Get all open extension orders for given project */
974
- extensionGetProjectExtensionInstanceOrders: (conf: {
975
- projectId: string;
976
- headers?: {
977
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
978
- "x-access-token"?: string | undefined;
979
- } | undefined;
980
- }) => import("@mittwald/react-use-promise").AsyncResource<{
981
- extensionId?: string;
982
- }[]>;
983
- /** Get payment method details */
984
- customerGetPaymentMethod: (conf: {
985
- customerId: string;
969
+ /** List ExtensionInstances. */
970
+ extensionListExtensionInstances: (conf?: {
986
971
  headers?: {
987
972
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
988
973
  "x-access-token"?: string | undefined;
989
974
  } | undefined;
990
- }) => import("@mittwald/react-use-promise").AsyncResource<{
991
- cardDetails?: {
992
- brand: string;
993
- last4: string;
994
- } | undefined;
995
- }>;
996
- /** List ContractPartners of the contributor. */
997
- contributorListContractPartnersOfContributor: (conf: {
998
- contributorId: string;
999
975
  queryParameters?: {
1000
976
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
977
+ context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext | undefined;
978
+ contextId?: string | undefined;
1001
979
  extensionId?: string | undefined;
1002
- extensionInstanceId?: string | undefined;
1003
- } | undefined;
1004
- headers?: {
1005
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1006
- "x-access-token"?: string | undefined;
1007
- } | undefined;
1008
- }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContractPartner[]>;
1009
- /** Get the public key to verify the webhook signature. */
1010
- extensionGetPublicKey: (conf: {
1011
- serial: string;
1012
- queryParameters?: {
1013
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1014
- purpose?: "webhook" | "session_token" | undefined;
1015
- format?: "raw" | "spki" | undefined;
1016
- } | undefined;
1017
- headers?: {
1018
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
980
+ searchTerm?: string | undefined;
981
+ limit?: number | undefined;
982
+ skip?: number | undefined;
983
+ page?: number | undefined;
984
+ sort?: ("createdAt" | "extensionId" | "extensionName")[] | undefined;
985
+ order?: ("asc" | "desc")[] | undefined;
1019
986
  } | undefined;
1020
- }) => import("@mittwald/react-use-promise").AsyncResource<{
1021
- algorithm: string;
1022
- key: string;
1023
- serial: string;
1024
- }>;
1025
- /** Get the ExtensionInstance of a specific customer and extension, if existing. */
1026
- extensionGetExtensionInstanceForCustomer: (conf: {
1027
- customerId: string;
1028
- extensionId: string;
987
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionInstance[]>;
988
+ /** Get an ExtensionInstance. */
989
+ extensionGetExtensionInstance: (conf: {
990
+ extensionInstanceId: string;
1029
991
  headers?: {
1030
992
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1031
993
  "x-access-token"?: string | undefined;
@@ -1049,43 +1011,80 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
1049
1011
  pendingInstallation: boolean;
1050
1012
  pendingRemoval: boolean;
1051
1013
  }>;
1052
- /** List Contributors. */
1053
- extensionListContributors: (conf?: {
1014
+ /** Get Extension of own contributor. */
1015
+ extensionGetOwnExtension: (conf: {
1016
+ contributorId: string;
1017
+ extensionId: string;
1054
1018
  headers?: {
1055
1019
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1020
+ "x-access-token"?: string | undefined;
1056
1021
  } | undefined;
1057
- queryParameters?: {
1058
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1059
- limit?: number | undefined;
1060
- skip?: number | undefined;
1061
- page?: number | undefined;
1062
- } | undefined;
1063
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContributor[]>;
1064
- /** Get a Contributor. */
1065
- extensionGetContributor: (conf: {
1022
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1023
+ assets: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionAsset[];
1024
+ backendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceBackendComponents | undefined;
1025
+ blocked?: boolean | undefined;
1026
+ context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext | undefined;
1066
1027
  contributorId: string;
1067
- headers?: {
1068
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1028
+ deprecation?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionDeprecation | undefined;
1029
+ description?: string | undefined;
1030
+ detailedDescriptions?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceDetailedDescriptions | undefined;
1031
+ disabled?: boolean | undefined;
1032
+ externalFrontends?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
1033
+ frontendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
1034
+ frontendFragments?: {
1035
+ [k: string]: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceFrontendFragment;
1069
1036
  } | undefined;
1070
- }) => import("@mittwald/react-use-promise").AsyncResource<import("@mittwald/api-client-commons").Simplify<import("./types.js").MittwaldAPIV2.Paths.V2ContributorsContributorId.Get.Responses.$200.Content.ApplicationJson>>;
1071
- /** List Scopes. */
1072
- extensionListScopes: (conf?: {
1037
+ functional: boolean;
1038
+ id: string;
1039
+ logoRefId?: string | undefined;
1040
+ name: string;
1041
+ pricing?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceMonthlyPricePlanStrategy | undefined;
1042
+ published: boolean;
1043
+ requestedChanges?: {
1044
+ context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext;
1045
+ scopes?: string[];
1046
+ webhookUrls?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceWebhookUrls | {};
1047
+ } | undefined;
1048
+ scopes?: string[] | undefined;
1049
+ secrets: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionSecret[];
1050
+ state?: "enabled" | "blocked" | "disabled" | undefined;
1051
+ statistics: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionStatistics;
1052
+ subTitle?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSubTitle | undefined;
1053
+ support?: (import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSupportMeta & {
1054
+ inherited: boolean;
1055
+ }) | undefined;
1056
+ tags?: string[] | undefined;
1057
+ verificationRequested: boolean;
1058
+ verified: boolean;
1059
+ webhookUrls?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceWebhookUrls | undefined;
1060
+ }>;
1061
+ /** Get all open extension orders for given customer */
1062
+ extensionGetCustomerExtensionInstanceOrders: (conf: {
1063
+ customerId: string;
1073
1064
  headers?: {
1074
1065
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1066
+ "x-access-token"?: string | undefined;
1075
1067
  } | undefined;
1076
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
1077
- name: string;
1068
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1069
+ extensionId?: string;
1078
1070
  }[]>;
1079
- /** Get an Extension. */
1080
- extensionGetExtension: (conf: {
1081
- extensionId: string;
1071
+ /** Get the Contract Strategy of an Extension Instance */
1072
+ extensionGetExtensionInstanceContract: (conf: {
1073
+ extensionInstanceId: string;
1082
1074
  headers?: {
1083
1075
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1076
+ "x-access-token"?: string | undefined;
1084
1077
  } | undefined;
1085
- }) => import("@mittwald/react-use-promise").AsyncResource<import("@mittwald/api-client-commons").Simplify<import("./types.js").MittwaldAPIV2.Paths.V2ExtensionsExtensionId.Get.Responses.$200.Content.ApplicationJson>>;
1086
- /** Get the ExtensionInstance of a specific project and extension, if existing. */
1087
- extensionGetExtensionInstanceForProject: (conf: {
1088
- projectId: string;
1078
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1079
+ currentPrice?: number | undefined;
1080
+ interactionDeadline?: string | undefined;
1081
+ interactionRequired: boolean;
1082
+ status: "notStarted" | "pending" | "active" | "terminationPending";
1083
+ terminationTargetDate?: string | undefined;
1084
+ }>;
1085
+ /** Get the ExtensionInstance of a specific customer and extension, if existing. */
1086
+ extensionGetExtensionInstanceForCustomer: (conf: {
1087
+ customerId: string;
1089
1088
  extensionId: string;
1090
1089
  headers?: {
1091
1090
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
@@ -1110,9 +1109,10 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
1110
1109
  pendingInstallation: boolean;
1111
1110
  pendingRemoval: boolean;
1112
1111
  }>;
1113
- /** Get an ExtensionInstance. */
1114
- extensionGetExtensionInstance: (conf: {
1115
- extensionInstanceId: string;
1112
+ /** Get the ExtensionInstance of a specific project and extension, if existing. */
1113
+ extensionGetExtensionInstanceForProject: (conf: {
1114
+ projectId: string;
1115
+ extensionId: string;
1116
1116
  headers?: {
1117
1117
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1118
1118
  "x-access-token"?: string | undefined;
@@ -1136,86 +1136,51 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
1136
1136
  pendingInstallation: boolean;
1137
1137
  pendingRemoval: boolean;
1138
1138
  }>;
1139
- /** List ExtensionInstances. */
1140
- extensionListExtensionInstances: (conf?: {
1139
+ /** Get an Extension. */
1140
+ extensionGetExtension: (conf: {
1141
+ extensionId: string;
1142
+ headers?: {
1143
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1144
+ } | undefined;
1145
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("@mittwald/api-client-commons").Simplify<import("./types.js").MittwaldAPIV2.Paths.V2ExtensionsExtensionId.Get.Responses.$200.Content.ApplicationJson>>;
1146
+ /** Get all open extension orders for given project */
1147
+ extensionGetProjectExtensionInstanceOrders: (conf: {
1148
+ projectId: string;
1141
1149
  headers?: {
1142
1150
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1143
1151
  "x-access-token"?: string | undefined;
1144
1152
  } | undefined;
1153
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1154
+ extensionId?: string;
1155
+ }[]>;
1156
+ /** Get the public key to verify the webhook signature. */
1157
+ extensionGetPublicKey: (conf: {
1158
+ serial: string;
1145
1159
  queryParameters?: {
1146
1160
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1147
- context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext | undefined;
1148
- contextId?: string | undefined;
1149
- extensionId?: string | undefined;
1150
- searchTerm?: string | undefined;
1151
- limit?: number | undefined;
1152
- skip?: number | undefined;
1153
- page?: number | undefined;
1154
- sort?: ("createdAt" | "extensionId" | "extensionName")[] | undefined;
1155
- order?: ("asc" | "desc")[] | undefined;
1161
+ purpose?: "webhook" | "session_token" | undefined;
1162
+ format?: "raw" | "spki" | undefined;
1156
1163
  } | undefined;
1157
- } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionInstance[]>;
1158
- /** Get Extension of own contributor. */
1159
- extensionGetOwnExtension: (conf: {
1160
- contributorId: string;
1161
- extensionId: string;
1162
1164
  headers?: {
1163
1165
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1164
- "x-access-token"?: string | undefined;
1165
1166
  } | undefined;
1166
1167
  }) => import("@mittwald/react-use-promise").AsyncResource<{
1167
- assets: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionAsset[];
1168
- backendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceBackendComponents | undefined;
1169
- blocked?: boolean | undefined;
1170
- context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext | undefined;
1171
- contributorId: string;
1172
- deprecation?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionDeprecation | undefined;
1173
- description?: string | undefined;
1174
- detailedDescriptions?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceDetailedDescriptions | undefined;
1175
- disabled?: boolean | undefined;
1176
- externalFrontends?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
1177
- frontendComponents?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[] | undefined;
1178
- frontendFragments?: {
1179
- [k: string]: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceFrontendFragment;
1180
- } | undefined;
1181
- functional: boolean;
1182
- id: string;
1183
- logoRefId?: string | undefined;
1184
- name: string;
1185
- pricing?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceMonthlyPricePlanStrategy | undefined;
1186
- published: boolean;
1187
- requestedChanges?: {
1188
- context?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContext;
1189
- scopes?: string[];
1190
- webhookUrls?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceWebhookUrls | {};
1191
- } | undefined;
1192
- scopes?: string[] | undefined;
1193
- secrets: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionSecret[];
1194
- state?: "enabled" | "blocked" | "disabled" | undefined;
1195
- statistics: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtensionStatistics;
1196
- subTitle?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSubTitle | undefined;
1197
- support?: (import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceSupportMeta & {
1198
- inherited: boolean;
1199
- }) | undefined;
1200
- tags?: string[] | undefined;
1201
- verificationRequested: boolean;
1202
- verified: boolean;
1203
- webhookUrls?: import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceWebhookUrls | undefined;
1168
+ algorithm: string;
1169
+ key: string;
1170
+ serial: string;
1204
1171
  }>;
1205
- /** List Extensions of own contributor. */
1206
- extensionListOwnExtensions: (conf: {
1207
- contributorId: string;
1172
+ /** List Contributors. */
1173
+ extensionListContributors: (conf?: {
1174
+ headers?: {
1175
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1176
+ } | undefined;
1208
1177
  queryParameters?: {
1209
1178
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1210
1179
  limit?: number | undefined;
1211
1180
  skip?: number | undefined;
1212
1181
  page?: number | undefined;
1213
1182
  } | undefined;
1214
- headers?: {
1215
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1216
- "x-access-token"?: string | undefined;
1217
- } | undefined;
1218
- }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceOwnExtension[]>;
1183
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContributor[]>;
1219
1184
  /** List Extensions. */
1220
1185
  extensionListExtensions: (conf?: {
1221
1186
  headers?: {
@@ -1233,6 +1198,41 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
1233
1198
  order?: "asc" | "desc" | undefined;
1234
1199
  } | undefined;
1235
1200
  } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceExtension[]>;
1201
+ /** List Extensions of own contributor. */
1202
+ extensionListOwnExtensions: (conf: {
1203
+ contributorId: string;
1204
+ queryParameters?: {
1205
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1206
+ limit?: number | undefined;
1207
+ skip?: number | undefined;
1208
+ page?: number | undefined;
1209
+ } | undefined;
1210
+ headers?: {
1211
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1212
+ "x-access-token"?: string | undefined;
1213
+ } | undefined;
1214
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceOwnExtension[]>;
1215
+ /** List Scopes. */
1216
+ extensionListScopes: (conf?: {
1217
+ headers?: {
1218
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1219
+ } | undefined;
1220
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<{
1221
+ name: string;
1222
+ }[]>;
1223
+ /** Get payment method details */
1224
+ customerGetPaymentMethod: (conf: {
1225
+ customerId: string;
1226
+ headers?: {
1227
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1228
+ "x-access-token"?: string | undefined;
1229
+ } | undefined;
1230
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
1231
+ cardDetails?: {
1232
+ brand: string;
1233
+ last4: string;
1234
+ } | undefined;
1235
+ }>;
1236
1236
  };
1237
1237
  declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
1238
1238
  /** Get all conversation the authenticated user has created or has access to. */