@mittwald/api-client 4.118.0 → 4.120.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.
@@ -194,6 +194,10 @@ export class MittwaldAPIV2Client extends ApiClientBase {
194
194
  extensionListOwnExtensions: this.requestFunctionFactory(descriptors.extensionListOwnExtensions),
195
195
  /** Register an Extension. */
196
196
  extensionRegisterExtension: this.requestFunctionFactory(descriptors.extensionRegisterExtension),
197
+ /** Start the verification process of an Extension. */
198
+ extensionRequestExtensionVerification: this.requestFunctionFactory(descriptors.extensionRequestExtensionVerification),
199
+ /** Publish or withdraw an Extension. */
200
+ extensionSetExtensionPublishedState: this.requestFunctionFactory(descriptors.extensionSetExtensionPublishedState),
197
201
  };
198
202
  /** The conversation API allows you to manage your support conversations. */
199
203
  conversation = {
@@ -1072,6 +1072,18 @@ export const extensionRegisterExtension = {
1072
1072
  method: "POST",
1073
1073
  operationId: "extension-register-extension",
1074
1074
  };
1075
+ /** Start the verification process of an Extension. */
1076
+ export const extensionRequestExtensionVerification = {
1077
+ path: "/v2/contributors/{contributorId}/extensions/{extensionId}/verification-process",
1078
+ method: "POST",
1079
+ operationId: "extension-request-extension-verification",
1080
+ };
1081
+ /** Publish or withdraw an Extension. */
1082
+ export const extensionSetExtensionPublishedState = {
1083
+ path: "/v2/contributors/{contributorId}/extensions/{extensionId}/published",
1084
+ method: "PUT",
1085
+ operationId: "extension-set-extension-published-state",
1086
+ };
1075
1087
  /** Create a File. */
1076
1088
  export const fileCreateFile = {
1077
1089
  path: "/v2/files",
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.117.0';
1
+ export const MittwaldAPIClientVersion = '4.119.0';
@@ -5857,6 +5857,120 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
5857
5857
  }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
5858
5858
  [x: string]: unknown;
5859
5859
  }, 429, "application/json">>>;
5860
+ /** Start the verification process of an Extension. */
5861
+ extensionRequestExtensionVerification: (request: {
5862
+ contributorId: string;
5863
+ extensionId: string;
5864
+ headers?: {
5865
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
5866
+ "x-access-token"?: string | undefined;
5867
+ } | undefined;
5868
+ }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
5869
+ headers?: Partial<{
5870
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5871
+ }>;
5872
+ } & {
5873
+ pathParameters: {
5874
+ contributorId: string;
5875
+ extensionId: string;
5876
+ };
5877
+ } & {
5878
+ headers: {
5879
+ "x-access-token"?: string | undefined;
5880
+ } & Partial<{
5881
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5882
+ }>;
5883
+ }, import("@mittwald/api-client-commons").Response<{}, 204, "application/json"> | import("@mittwald/api-client-commons").Response<{
5884
+ [x: string]: unknown;
5885
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
5886
+ [x: string]: unknown;
5887
+ }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
5888
+ headers?: Partial<{
5889
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5890
+ }>;
5891
+ } & {
5892
+ pathParameters: {
5893
+ contributorId: string;
5894
+ extensionId: string;
5895
+ };
5896
+ } & {
5897
+ headers: {
5898
+ "x-access-token"?: string | undefined;
5899
+ } & Partial<{
5900
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5901
+ }>;
5902
+ }, import("@mittwald/api-client-commons").Response<{}, 204, "application/json"> | import("@mittwald/api-client-commons").Response<{
5903
+ [x: string]: unknown;
5904
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
5905
+ [x: string]: unknown;
5906
+ }, 429, "application/json">>>;
5907
+ /** Publish or withdraw an Extension. */
5908
+ extensionSetExtensionPublishedState: (request: {
5909
+ data: {
5910
+ published: boolean;
5911
+ reason?: string | undefined;
5912
+ };
5913
+ contributorId: string;
5914
+ extensionId: string;
5915
+ headers?: {
5916
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
5917
+ "x-access-token"?: string | undefined;
5918
+ } | undefined;
5919
+ }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
5920
+ data: {
5921
+ published: boolean;
5922
+ reason?: string | undefined;
5923
+ };
5924
+ } & {
5925
+ pathParameters: {
5926
+ contributorId: string;
5927
+ extensionId: string;
5928
+ };
5929
+ } & {
5930
+ headers?: Partial<{
5931
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5932
+ }>;
5933
+ } & {
5934
+ headers: {
5935
+ "x-access-token"?: string | undefined;
5936
+ } & Partial<{
5937
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5938
+ }>;
5939
+ }, import("@mittwald/api-client-commons").Response<{
5940
+ id: string;
5941
+ published: boolean;
5942
+ }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
5943
+ [x: string]: unknown;
5944
+ }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
5945
+ [x: string]: unknown;
5946
+ }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
5947
+ data: {
5948
+ published: boolean;
5949
+ reason?: string | undefined;
5950
+ };
5951
+ } & {
5952
+ pathParameters: {
5953
+ contributorId: string;
5954
+ extensionId: string;
5955
+ };
5956
+ } & {
5957
+ headers?: Partial<{
5958
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5959
+ }>;
5960
+ } & {
5961
+ headers: {
5962
+ "x-access-token"?: string | undefined;
5963
+ } & Partial<{
5964
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
5965
+ }>;
5966
+ }, import("@mittwald/api-client-commons").Response<{
5967
+ id: string;
5968
+ published: boolean;
5969
+ }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
5970
+ [x: string]: unknown;
5971
+ }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
5972
+ [x: string]: unknown;
5973
+ }, 429, "application/json">>>;
5860
5974
  };
5861
5975
  /** The conversation API allows you to manage your support conversations. */
5862
5976
  readonly conversation: {
@@ -361,6 +361,10 @@ export declare const extensionListExtensions: OpenAPIOperation<RequestType<Simpl
361
361
  export declare const extensionListOwnExtensions: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
362
362
  /** Register an Extension. */
363
363
  export declare const extensionRegisterExtension: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Post.Responses.$201.Content.ApplicationJson>, 201, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensions.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
364
+ /** Start the verification process of an Extension. */
365
+ export declare const extensionRequestExtensionVerification: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdVerificationProcess.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdVerificationProcess.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdVerificationProcess.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdVerificationProcess.Post.Responses.$204.Content.ApplicationJson>, 204, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdVerificationProcess.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdVerificationProcess.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdVerificationProcess.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
366
+ /** Publish or withdraw an Extension. */
367
+ export declare const extensionSetExtensionPublishedState: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdPublished.Put.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdPublished.Put.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdPublished.Put.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdPublished.Put.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdPublished.Put.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdPublished.Put.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdPublished.Put.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ContributorsContributorIdExtensionsExtensionIdPublished.Put.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
364
368
  /** Create a File. */
365
369
  export declare const fileCreateFile: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2Files.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2Files.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2Files.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2Files.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2Files.Post.Responses.$201.Content.ApplicationJson>, 201, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Files.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Files.Post.Responses.$401.Content.ApplicationJson>, 401, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Files.Post.Responses.$406.Content.ApplicationJson>, 406, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Files.Post.Responses.$422.Content.ApplicationJson>, 422, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Files.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Files.Post.Responses.$500.Content.ApplicationJson>, 500, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2Files.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
366
370
  /** Get a File's meta. */
@@ -718,6 +718,14 @@ export declare namespace MittwaldAPIV2 {
718
718
  type RequestData = InferredRequestData<typeof descriptors.extensionRegisterExtension>;
719
719
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.extensionRegisterExtension, TStatus>;
720
720
  }
721
+ namespace ExtensionRequestExtensionVerification {
722
+ type RequestData = InferredRequestData<typeof descriptors.extensionRequestExtensionVerification>;
723
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.extensionRequestExtensionVerification, TStatus>;
724
+ }
725
+ namespace ExtensionSetExtensionPublishedState {
726
+ type RequestData = InferredRequestData<typeof descriptors.extensionSetExtensionPublishedState>;
727
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.extensionSetExtensionPublishedState, TStatus>;
728
+ }
721
729
  namespace FileCreateFile {
722
730
  type RequestData = InferredRequestData<typeof descriptors.fileCreateFile>;
723
731
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.fileCreateFile, TStatus>;
@@ -2503,6 +2511,9 @@ export declare namespace MittwaldAPIV2 {
2503
2511
  * The asset ID and reference ID to its file. Retrieve the file with this id on `/v2/files/{id}
2504
2512
  */
2505
2513
  id: string;
2514
+ /**
2515
+ * The index of the asset. Does not have to be successive. Can be used to order the assets.
2516
+ */
2506
2517
  index: number;
2507
2518
  }
2508
2519
  /**
@@ -12884,6 +12895,100 @@ export declare namespace MittwaldAPIV2 {
12884
12895
  }
12885
12896
  }
12886
12897
  }
12898
+ namespace V2ContributorsContributorIdExtensionsExtensionIdVerificationProcess {
12899
+ namespace Post {
12900
+ namespace Parameters {
12901
+ type Path = {
12902
+ contributorId: string;
12903
+ extensionId: string;
12904
+ };
12905
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
12906
+ type Query = {};
12907
+ }
12908
+ namespace Responses {
12909
+ namespace $204 {
12910
+ namespace Content {
12911
+ interface ApplicationJson {
12912
+ }
12913
+ }
12914
+ }
12915
+ namespace $400 {
12916
+ namespace Content {
12917
+ interface ApplicationJson {
12918
+ [k: string]: unknown;
12919
+ }
12920
+ }
12921
+ }
12922
+ namespace $429 {
12923
+ namespace Content {
12924
+ interface ApplicationJson {
12925
+ [k: string]: unknown;
12926
+ }
12927
+ }
12928
+ }
12929
+ namespace Default {
12930
+ namespace Content {
12931
+ interface ApplicationJson {
12932
+ [k: string]: unknown;
12933
+ }
12934
+ }
12935
+ }
12936
+ }
12937
+ }
12938
+ }
12939
+ namespace V2ContributorsContributorIdExtensionsExtensionIdPublished {
12940
+ namespace Put {
12941
+ namespace Parameters {
12942
+ type Path = {
12943
+ contributorId: string;
12944
+ extensionId: string;
12945
+ };
12946
+ interface RequestBody {
12947
+ /**
12948
+ * Whether the extension should be publicly visible.
12949
+ */
12950
+ published: boolean;
12951
+ /**
12952
+ * When setting withdrawing an extension a reason is required.
12953
+ */
12954
+ reason?: string;
12955
+ }
12956
+ type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
12957
+ type Query = {};
12958
+ }
12959
+ namespace Responses {
12960
+ namespace $200 {
12961
+ namespace Content {
12962
+ interface ApplicationJson {
12963
+ id: string;
12964
+ published: boolean;
12965
+ }
12966
+ }
12967
+ }
12968
+ namespace $404 {
12969
+ namespace Content {
12970
+ interface ApplicationJson {
12971
+ [k: string]: unknown;
12972
+ }
12973
+ }
12974
+ }
12975
+ namespace $429 {
12976
+ namespace Content {
12977
+ interface ApplicationJson {
12978
+ [k: string]: unknown;
12979
+ }
12980
+ }
12981
+ }
12982
+ namespace Default {
12983
+ namespace Content {
12984
+ interface ApplicationJson {
12985
+ [k: string]: unknown;
12986
+ }
12987
+ }
12988
+ }
12989
+ }
12990
+ }
12991
+ }
12887
12992
  namespace V2Files {
12888
12993
  namespace Post {
12889
12994
  namespace Parameters {
@@ -1 +1 @@
1
- export declare const MittwaldAPIClientVersion = '4.117.0';
1
+ export declare const MittwaldAPIClientVersion = '4.119.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "4.118.0",
3
+ "version": "4.120.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": "45b7aa7cd5e7b931300b868cc025f736c8cf9266"
83
+ "gitHead": "df7a169b4b93d605aa99dcac5ae6909e783e0d39"
84
84
  }