@mittwald/api-client 4.228.0 → 4.230.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.
@@ -227,6 +227,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
227
227
  contributorRequestDeviatingContributorAvatarUpload: this.requestFunctionFactory(descriptors.contributorRequestDeviatingContributorAvatarUpload),
228
228
  /** Delete deviating contributor avatar und return to the inherited customer avatar. */
229
229
  contributorResetContributorAvatar: this.requestFunctionFactory(descriptors.contributorResetContributorAvatar),
230
+ /** Start the verification process of a contributor. */
231
+ contributorRequestVerification: this.requestFunctionFactory(descriptors.contributorRequestVerification),
230
232
  /** Rotate the secret for an extension instance. */
231
233
  contributorRotateSecretForExtensionInstance: this.requestFunctionFactory(descriptors.contributorRotateSecretForExtensionInstance),
232
234
  /** Authenticate your external application using the extensionInstanceSecret. */
@@ -538,6 +538,12 @@ export const contributorResetContributorAvatar = {
538
538
  method: "DELETE",
539
539
  operationId: "contributor-reset-contributor-avatar",
540
540
  };
541
+ /** Start the verification process of a contributor. */
542
+ export const contributorRequestVerification = {
543
+ path: "/v2/contributors/{contributorId}/verification-process",
544
+ method: "POST",
545
+ operationId: "contributor-request-verification",
546
+ };
541
547
  /** Rotate the secret for an extension instance. */
542
548
  export const contributorRotateSecretForExtensionInstance = {
543
549
  path: "/v2/contributors/{contributorId}/extensions/{extensionId}/extension-instances/{extensionInstanceId}/secret",
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.227.0';
1
+ export const MittwaldAPIClientVersion = '4.229.0';
@@ -1893,6 +1893,7 @@ declare const buildDomainApi: (baseClient: MittwaldAPIV2Client) => {
1893
1893
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1894
1894
  projectId?: string | undefined;
1895
1895
  certificateId?: string | undefined;
1896
+ hostnameSubstring?: string | undefined;
1896
1897
  limit?: number | undefined;
1897
1898
  skip?: number | undefined;
1898
1899
  page?: number | undefined;
@@ -6319,6 +6319,8 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6319
6319
  inherited: boolean;
6320
6320
  };
6321
6321
  url?: string | undefined;
6322
+ verificationRequested: boolean;
6323
+ verified: boolean;
6322
6324
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
6323
6325
  [x: string]: unknown;
6324
6326
  }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -6370,6 +6372,8 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
6370
6372
  inherited: boolean;
6371
6373
  };
6372
6374
  url?: string | undefined;
6375
+ verificationRequested: boolean;
6376
+ verified: boolean;
6373
6377
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
6374
6378
  [x: string]: unknown;
6375
6379
  }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -7116,6 +7120,50 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
7116
7120
  }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
7117
7121
  [x: string]: unknown;
7118
7122
  }, 429, "application/json">>>;
7123
+ /** Start the verification process of a contributor. */
7124
+ contributorRequestVerification: (request: {
7125
+ contributorId: string;
7126
+ headers?: {
7127
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
7128
+ "x-access-token"?: string | undefined;
7129
+ } | undefined;
7130
+ }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
7131
+ headers?: Partial<{
7132
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
7133
+ }>;
7134
+ } & {
7135
+ pathParameters: {
7136
+ contributorId: string;
7137
+ };
7138
+ } & {
7139
+ headers: {
7140
+ "x-access-token"?: string | undefined;
7141
+ } & Partial<{
7142
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
7143
+ }>;
7144
+ }, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
7145
+ [x: string]: unknown;
7146
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
7147
+ [x: string]: unknown;
7148
+ }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
7149
+ headers?: Partial<{
7150
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
7151
+ }>;
7152
+ } & {
7153
+ pathParameters: {
7154
+ contributorId: string;
7155
+ };
7156
+ } & {
7157
+ headers: {
7158
+ "x-access-token"?: string | undefined;
7159
+ } & Partial<{
7160
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
7161
+ }>;
7162
+ }, import("@mittwald/api-client-commons").Response<{}, 204, "empty"> | import("@mittwald/api-client-commons").Response<{
7163
+ [x: string]: unknown;
7164
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
7165
+ [x: string]: unknown;
7166
+ }, 429, "application/json">>>;
7119
7167
  /** Rotate the secret for an extension instance. */
7120
7168
  contributorRotateSecretForExtensionInstance: (request: {
7121
7169
  contributorId: string;
@@ -16298,6 +16346,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
16298
16346
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
16299
16347
  projectId?: string | undefined;
16300
16348
  certificateId?: string | undefined;
16349
+ hostnameSubstring?: string | undefined;
16301
16350
  limit?: number | undefined;
16302
16351
  skip?: number | undefined;
16303
16352
  page?: number | undefined;
@@ -16310,6 +16359,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
16310
16359
  queryParameters: {
16311
16360
  projectId?: string | undefined;
16312
16361
  certificateId?: string | undefined;
16362
+ hostnameSubstring?: string | undefined;
16313
16363
  limit?: number | undefined;
16314
16364
  skip?: number | undefined;
16315
16365
  page?: number | undefined;
@@ -16334,6 +16384,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
16334
16384
  queryParameters: {
16335
16385
  projectId?: string | undefined;
16336
16386
  certificateId?: string | undefined;
16387
+ hostnameSubstring?: string | undefined;
16337
16388
  limit?: number | undefined;
16338
16389
  skip?: number | undefined;
16339
16390
  page?: number | undefined;
@@ -183,6 +183,8 @@ export declare const contributorReceiptGetFileAccessToken: OpenAPIOperation<Requ
183
183
  export declare const contributorRequestDeviatingContributorAvatarUpload: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
184
184
  /** Delete deviating contributor avatar und return to the inherited customer avatar. */
185
185
  export declare const contributorResetContributorAvatar: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Delete.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Delete.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Delete.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Delete.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Delete.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Delete.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdAvatar.Delete.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
186
+ /** Start the verification process of a contributor. */
187
+ export declare const contributorRequestVerification: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdVerificationProcess.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdVerificationProcess.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdVerificationProcess.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdVerificationProcess.Post.Responses.$204.Content.Empty>, 204, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdVerificationProcess.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdVerificationProcess.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdVerificationProcess.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
186
188
  /** Rotate the secret for an extension instance. */
187
189
  export declare const contributorRotateSecretForExtensionInstance: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret.Put.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret.Put.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret.Put.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret.Put.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret.Put.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret.Put.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret.Put.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret.Put.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret.Put.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
188
190
  /** Get all conversation the authenticated user has created or has access to. */
@@ -362,6 +362,10 @@ export declare namespace MittwaldAPIV2 {
362
362
  type RequestData = InferredRequestData<typeof descriptors.contributorResetContributorAvatar>;
363
363
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.contributorResetContributorAvatar, TStatus>;
364
364
  }
365
+ namespace ContributorRequestVerification {
366
+ type RequestData = InferredRequestData<typeof descriptors.contributorRequestVerification>;
367
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.contributorRequestVerification, TStatus>;
368
+ }
365
369
  namespace ContributorRotateSecretForExtensionInstance {
366
370
  type RequestData = InferredRequestData<typeof descriptors.contributorRotateSecretForExtensionInstance>;
367
371
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.contributorRotateSecretForExtensionInstance, TStatus>;
@@ -3087,6 +3091,8 @@ export declare namespace MittwaldAPIV2 {
3087
3091
  } | {
3088
3092
  url: string;
3089
3093
  };
3094
+ /**
3095
+ */
3090
3096
  type MarketplaceContributorState = "enabled" | "disabled";
3091
3097
  interface MarketplaceExtension {
3092
3098
  /**
@@ -3120,6 +3126,9 @@ export declare namespace MittwaldAPIV2 {
3120
3126
  */
3121
3127
  description: string;
3122
3128
  detailedDescriptions?: MittwaldAPIV2.Components.Schemas.MarketplaceDetailedDescriptions;
3129
+ /**
3130
+ * @deprecated
3131
+ */
3123
3132
  disabled: boolean;
3124
3133
  externalFrontends?: MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[];
3125
3134
  /**
@@ -3335,6 +3344,8 @@ export declare namespace MittwaldAPIV2 {
3335
3344
  * @deprecated
3336
3345
  */
3337
3346
  url?: string;
3347
+ verificationRequested: boolean;
3348
+ verified: boolean;
3338
3349
  }
3339
3350
  interface MarketplaceOwnExtension {
3340
3351
  assets: MittwaldAPIV2.Components.Schemas.MarketplaceExtensionAsset[];
@@ -3348,6 +3359,9 @@ export declare namespace MittwaldAPIV2 {
3348
3359
  deprecation?: MittwaldAPIV2.Components.Schemas.MarketplaceExtensionDeprecation;
3349
3360
  description?: string;
3350
3361
  detailedDescriptions?: MittwaldAPIV2.Components.Schemas.MarketplaceDetailedDescriptions;
3362
+ /**
3363
+ * @deprecated
3364
+ */
3351
3365
  disabled?: boolean;
3352
3366
  externalFrontends?: MittwaldAPIV2.Components.Schemas.MarketplaceExternalComponent[];
3353
3367
  /**
@@ -3374,6 +3388,7 @@ export declare namespace MittwaldAPIV2 {
3374
3388
  scopes?: string[];
3375
3389
  secrets: MittwaldAPIV2.Components.Schemas.MarketplaceExtensionSecret[];
3376
3390
  /**
3391
+ * @deprecated
3377
3392
  * deprecated
3378
3393
  */
3379
3394
  state?: "enabled" | "blocked" | "disabled";
@@ -10116,6 +10131,45 @@ export declare namespace MittwaldAPIV2 {
10116
10131
  }
10117
10132
  }
10118
10133
  }
10134
+ namespace V2ContributorsContributorIdVerificationProcess {
10135
+ namespace Post {
10136
+ namespace Parameters {
10137
+ type Path = {
10138
+ contributorId: string;
10139
+ };
10140
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
10141
+ type Query = {};
10142
+ }
10143
+ namespace Responses {
10144
+ namespace $204 {
10145
+ namespace Content {
10146
+ type Empty = unknown;
10147
+ }
10148
+ }
10149
+ namespace $400 {
10150
+ namespace Content {
10151
+ interface ApplicationJson {
10152
+ [k: string]: unknown;
10153
+ }
10154
+ }
10155
+ }
10156
+ namespace $429 {
10157
+ namespace Content {
10158
+ interface ApplicationJson {
10159
+ [k: string]: unknown;
10160
+ }
10161
+ }
10162
+ }
10163
+ namespace Default {
10164
+ namespace Content {
10165
+ interface ApplicationJson {
10166
+ [k: string]: unknown;
10167
+ }
10168
+ }
10169
+ }
10170
+ }
10171
+ }
10172
+ }
10119
10173
  namespace V2ContributorsContributorIdExtensionsExtensionIdExtensionInstancesExtensionInstanceIdSecret {
10120
10174
  namespace Put {
10121
10175
  namespace Parameters {
@@ -17857,6 +17911,7 @@ export declare namespace MittwaldAPIV2 {
17857
17911
  type Query = {
17858
17912
  projectId?: string;
17859
17913
  certificateId?: string;
17914
+ hostnameSubstring?: string;
17860
17915
  limit?: number;
17861
17916
  skip?: number;
17862
17917
  page?: number;
@@ -1 +1 @@
1
- export declare const MittwaldAPIClientVersion = '4.227.0';
1
+ export declare const MittwaldAPIClientVersion = '4.229.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "4.228.0",
3
+ "version": "4.230.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",
@@ -80,5 +80,5 @@
80
80
  "optional": true
81
81
  }
82
82
  },
83
- "gitHead": "4efe0945dd52159ccb10dad758cd2fd554b1c30a"
83
+ "gitHead": "d50c01866bb27e7d9f697a1b6efdd955d8c8130d"
84
84
  }