@cheqd/studio 3.12.1 → 3.13.0-develop.10

package/dist/static/swagger-api.json

@@ -415,6 +415,49 @@
                     ]
                 }
             },
+            "ListCredentialResult": {
+                "type": "object",
+                "properties": {
+                    "total": {
+                        "type": "number"
+                    },
+                    "credentials": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "status": {
+                                    "type": "string"
+                                },
+                                "providerId": {
+                                    "type": "string"
+                                },
+                                "id": {
+                                    "type": "string"
+                                },
+                                "issuerDid": {
+                                    "type": "string"
+                                },
+                                "subjectDid": {
+                                    "type": "string"
+                                },
+                                "type": {
+                                    "type": "string"
+                                },
+                                "createdAt": {
+                                    "type": "string"
+                                },
+                                "format": {
+                                    "type": "string"
+                                },
+                                "credentialStatus": {
+                                    "type": "object"
+                                }
+                            }
+                        }
+                    }
+                }
+            },
             "CredentialRevokeRequest": {
                 "type": "object",
                 "properties": {
@@ -1722,6 +1765,11 @@
                             "mainnet"
                         ]
                     },
+                    "providerId": {
+                        "description": "Identity Provider to create the DID",
+                        "type": "string",
+                        "required": false
+                    },
                     "identifierFormatType": {
                         "description": "Algorithm to use for generating the method-specific ID. The two styles supported are UUIDs and Indy-style Base58. See <a href=\"https://docs.cheqd.io/identity/architecture/adr-list/adr-001-cheqd-did-method#cheqd-did-method-did-cheqd\">cheqd DID method documentation</a> for more details.",
                         "type": "string",
@@ -1795,6 +1843,11 @@
                             "mainnet"
                         ]
                     },
+                    "providerId": {
+                        "description": "Identity Provider to create the DID",
+                        "type": "string",
+                        "required": false
+                    },
                     "identifierFormatType": {
                         "description": "Algorithm to use for generating the method-specific ID. The two styles supported are UUIDs and Indy-style Base58. See <a href=\"https://docs.cheqd.io/identity/architecture/adr-list/adr-001-cheqd-did-method#cheqd-did-method-did-cheqd\">cheqd DID method documentation</a> for more details.",
                         "type": "string",
@@ -1926,6 +1979,93 @@
                     }
                 }
             },
+            "ExportDidResult": {
+                "type": "object",
+                "properties": {
+                    "@context": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        },
+                        "example": [
+                            "https://w3id.org/wallet/v1",
+                            "https://w3id.org/did-resolution/v1"
+                        ]
+                    },
+                    "id": {
+                        "type": "string",
+                        "example": "did:cheqd:testnet:f5101dd8-447f-40a7-a9b8-700abeba389a"
+                    },
+                    "type": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        },
+                        "example": [
+                            "DIDResolutionResponse"
+                        ]
+                    },
+                    "didDidResolutionMetadata": {
+                        "$ref": "#/components/schemas/DidResolutionMetadata"
+                    },
+                    "didDocument": {
+                        "$ref": "#/components/schemas/DidDocument"
+                    },
+                    "didDocumentMetadata": {
+                        "$ref": "#/components/schemas/DeactivatedDidDocumentMetadata"
+                    },
+                    "keys": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "@context": {
+                                    "type": "array",
+                                    "items": {
+                                        "type": "string"
+                                    }
+                                },
+                                "id": {
+                                    "type": "string"
+                                },
+                                "type": {
+                                    "type": "array",
+                                    "items": {
+                                        "type": "string"
+                                    }
+                                },
+                                "controller": {
+                                    "type": "string"
+                                },
+                                "name": {
+                                    "type": "string"
+                                },
+                                "correlation": {
+                                    "type": "array",
+                                    "items": {
+                                        "type": "string"
+                                    }
+                                },
+                                "created": {
+                                    "type": "string"
+                                },
+                                "publicKeyMultibase": {
+                                    "type": "string"
+                                },
+                                "privateKeyMultibase": {
+                                    "type": "string"
+                                },
+                                "publicKeyBase58": {
+                                    "type": "string"
+                                },
+                                "privateKeyBase58": {
+                                    "type": "string"
+                                }
+                            }
+                        }
+                    }
+                }
+            },
             "DidUpdateResponse": {
                 "type": "object",
                 "properties": {
@@ -3856,6 +3996,84 @@
                 }
             }
         },
+        "/credential/list": {
+            "get": {
+                "tags": [
+                    "Verifiable Credentials"
+                ],
+                "summary": "Fetch credentials associated with an account.",
+                "description": "This endpoint returns the list of credentials controlled by the account.",
+                "parameters": [
+                    {
+                        "in": "query",
+                        "name": "providerId",
+                        "description": "Filter credentials by the provider.",
+                        "schema": {
+                            "type": "string"
+                        },
+                        "required": false
+                    },
+                    {
+                        "in": "query",
+                        "name": "issuerDid",
+                        "description": "Filter credentials by Issuer.",
+                        "schema": {
+                            "type": "string"
+                        },
+                        "required": false
+                    },
+                    {
+                        "in": "query",
+                        "name": "createdAt",
+                        "description": "Filter resource by created date.",
+                        "schema": {
+                            "type": "string",
+                            "format": "date"
+                        },
+                        "required": false
+                    },
+                    {
+                        "in": "query",
+                        "name": "page",
+                        "description": "Page number.",
+                        "schema": {
+                            "type": "number"
+                        },
+                        "required": false
+                    },
+                    {
+                        "in": "query",
+                        "name": "limit",
+                        "description": "Number of items to be listed in a single page.",
+                        "schema": {
+                            "type": "number"
+                        },
+                        "required": false
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "The request was successful.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ListCredentialResult"
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "$ref": "#/components/schemas/InvalidRequest"
+                    },
+                    "401": {
+                        "$ref": "#/components/schemas/UnauthorizedError"
+                    },
+                    "500": {
+                        "$ref": "#/components/schemas/InternalError"
+                    }
+                }
+            }
+        },
         "/did/create": {
             "post": {
                 "tags": [
@@ -4104,6 +4322,24 @@
                         },
                         "required": false
                     },
+                    {
+                        "in": "query",
+                        "name": "providerId",
+                        "description": "Filter DID by the provider.",
+                        "schema": {
+                            "type": "string"
+                        },
+                        "required": false
+                    },
+                    {
+                        "in": "query",
+                        "name": "metadata",
+                        "description": "Include metadata in response.",
+                        "schema": {
+                            "type": "boolean"
+                        },
+                        "required": false
+                    },
                     {
                         "in": "query",
                         "name": "createdAt",
@@ -4257,6 +4493,101 @@
                 }
             }
         },
+        "/did/export/{did}": {
+            "post": {
+                "tags": [
+                    "Decentralized Identifiers (DIDs)"
+                ],
+                "summary": "Export a DID Document.",
+                "description": "This endpoint exports a decentralized identifier associated with the user's account with the custodied keys.",
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "did",
+                        "description": "DID identifier to resolve.",
+                        "schema": {
+                            "type": "string"
+                        },
+                        "required": true
+                    }
+                ],
+                "requestBody": {
+                    "content": {
+                        "application/x-www-form-urlencoded": {
+                            "schema": {
+                                "type": "object",
+                                "properties": {
+                                    "password": {
+                                        "type": "string",
+                                        "required": false
+                                    },
+                                    "providerId": {
+                                        "type": "string",
+                                        "required": false
+                                    }
+                                }
+                            }
+                        },
+                        "application/json": {
+                            "schema": {
+                                "type": "object",
+                                "properties": {
+                                    "password": {
+                                        "type": "string",
+                                        "required": false
+                                    },
+                                    "providerId": {
+                                        "type": "string",
+                                        "required": false
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "The request was successful.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ExportDidResult"
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/InvalidRequest"
+                                },
+                                "example": {
+                                    "error": "InvalidRequest"
+                                }
+                            }
+                        }
+                    },
+                    "401": {
+                        "$ref": "#/components/schemas/UnauthorizedError"
+                    },
+                    "500": {
+                        "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/InvalidRequest"
+                                },
+                                "example": {
+                                    "error": "Internal Error"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/key/create": {
             "post": {
                 "tags": [
@@ -4679,6 +5010,298 @@
                 }
             }
         },
+        "/providers": {
+            "get": {
+                "tags": [
+                    "Providers"
+                ],
+                "summary": "Get all available credential providers",
+                "description": "Returns list of available credential providers",
+                "responses": {
+                    "200": {
+                        "description": "Successful response",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "providers": {
+                                            "type": "array",
+                                            "items": {
+                                                "type": "object"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "/providers/activated": {
+            "get": {
+                "tags": [
+                    "Providers"
+                ],
+                "summary": "Get customer's activated providers",
+                "description": "Returns list of providers activated by the customer",
+                "responses": {
+                    "200": {
+                        "description": "Successful response"
+                    }
+                }
+            }
+        },
+        "/providers/{providerId}/configuration": {
+            "get": {
+                "tags": [
+                    "Providers"
+                ],
+                "summary": "Get provider configuration",
+                "parameters": [
+                    {
+                        "name": "providerId",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Provider configuration"
+                    }
+                }
+            },
+            "put": {
+                "tags": [
+                    "Providers"
+                ],
+                "summary": "Update provider configuration",
+                "parameters": [
+                    {
+                        "name": "providerId",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "requestBody": {
+                    "required": true,
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "type": "object",
+                                "properties": {
+                                    "apiEndpoint": {
+                                        "type": "string",
+                                        "format": "uri",
+                                        "description": "API endpoint URL"
+                                    },
+                                    "webhookUrl": {
+                                        "type": "string",
+                                        "format": "uri",
+                                        "description": "Webhook URL for notifications"
+                                    },
+                                    "defaultSettings": {
+                                        "type": "object",
+                                        "description": "Provider-specific default settings"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "Configuration updated successfully"
+                    },
+                    "400": {
+                        "description": "Invalid configuration data"
+                    },
+                    "404": {
+                        "description": "Provider configuration not found"
+                    }
+                }
+            }
+        },
+        "/providers/{providerId}/activate": {
+            "post": {
+                "tags": [
+                    "Providers"
+                ],
+                "summary": "Activate a provider for the customer",
+                "parameters": [
+                    {
+                        "name": "providerId",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Provider activated successfully"
+                    },
+                    "400": {
+                        "description": "Invalid provider or already activated"
+                    },
+                    "404": {
+                        "description": "Provider not found"
+                    }
+                }
+            }
+        },
+        "/providers/{providerId}/test": {
+            "post": {
+                "tags": [
+                    "Providers"
+                ],
+                "summary": "Test connection to a provider",
+                "parameters": [
+                    {
+                        "name": "providerId",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Connection test completed"
+                    },
+                    "400": {
+                        "description": "Connection test failed"
+                    },
+                    "404": {
+                        "description": "Provider configuration not found"
+                    }
+                }
+            }
+        },
+        "/providers/{providerId}": {
+            "delete": {
+                "tags": [
+                    "Providers"
+                ],
+                "summary": "Remove provider configuration",
+                "parameters": [
+                    {
+                        "name": "providerId",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Configuration removed successfully"
+                    }
+                }
+            }
+        },
+        "/providers/{providerId}/did/import": {
+            "post": {
+                "tags": [
+                    "Providers"
+                ],
+                "summary": "Import a DID into a Provider.",
+                "description": "This endpoint imports a decentralized identifier associated with the user's account with the custodied keys into a provider.",
+                "parameters": [
+                    {
+                        "name": "providerId",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "requestBody": {
+                    "content": {
+                        "application/x-www-form-urlencoded": {
+                            "schema": {
+                                "type": "object",
+                                "required": [
+                                    "did"
+                                ],
+                                "properties": {
+                                    "did": {
+                                        "description": "DID identifier to resolve.",
+                                        "type": "string"
+                                    }
+                                }
+                            }
+                        },
+                        "application/json": {
+                            "schema": {
+                                "type": "object",
+                                "required": [
+                                    "did"
+                                ],
+                                "properties": {
+                                    "did": {
+                                        "description": "DID identifier to resolve.",
+                                        "type": "string"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "The request was successful.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/DidResult"
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/InvalidRequest"
+                                },
+                                "example": {
+                                    "error": "InvalidRequest"
+                                }
+                            }
+                        }
+                    },
+                    "401": {
+                        "$ref": "#/components/schemas/UnauthorizedError"
+                    },
+                    "500": {
+                        "description": "An internal error has occurred. Additional state information plus metadata may be available in the response body.",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/InvalidRequest"
+                                },
+                                "example": {
+                                    "error": "Internal Error"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/resource/create/{did}": {
             "post": {
                 "tags": [

package/dist/types/constants.d.ts

@@ -60,6 +60,7 @@ export declare enum OperationNameEnum {
     DID_SEARCH = "did-search",
     DID_IMPORT = "did-import",
     DID_LIST = "did-list",
+    DID_EXPORT = "did-export",
     RESOURCE_CREATE = "resource-create",
     RESOURCE_SEARCH = "resource-search",
     CREDENTIAL_STATUS_CREATE_UNENCRYPTED = "credential-status-create-unencrypted",