{ "x-generator": "NSwag v14.6.2.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "Infuse Marketplace API", "version": "v1" }, "servers": [ { "url": "https://api.dev.infuse-cloud.io" } ], "paths": { "/marketplace/webhooks/stripe": { "post": { "tags": ["Stripe", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsWebhooksStripeWebhookEndpoint", "responses": { "204": { "description": "No Content" } }, "security": [] } }, "/marketplace/earnings/statements": { "get": { "tags": ["Statements", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsSettlementReportsGetMarketplaceSettlementStatementsEndpoint", "parameters": [ { "name": "periodStartUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "periodEndUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "currency", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "role", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/MarketplaceSettlementStatementRoleFilter" } ] } }, { "name": "status", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/MarketplaceSettlementStatementStatusFilter" } ] } }, { "name": "organisationId", "in": "query", "schema": { "type": "string", "format": "guid", "nullable": true } }, { "name": "batchId", "in": "query", "schema": { "type": "string", "format": "guid", "nullable": true } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceSettlementStatementsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/earnings/statements/{statementId}": { "get": { "tags": ["Statements", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsSettlementReportsGetMarketplaceSettlementStatementByIdEndpoint", "parameters": [ { "name": "statementId", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceSettlementStatementByIdResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/earnings/statements/{statementId}/export.csv": { "get": { "tags": ["Statements", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsSettlementReportsExportMarketplaceSettlementStatementCsvEndpoint", "parameters": [ { "name": "statementId", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/earnings/statements/{statementId}/export.pdf": { "get": { "tags": ["Statements", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsSettlementReportsExportMarketplaceSettlementStatementPdfEndpoint", "parameters": [ { "name": "statementId", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/marketplace-items/{id}": { "get": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Get Item", "description": "Fetches the core details of a specific marketplace item, including its type, organization, and creation timestamp.", "operationId": "InfusePlatformMarketplaceApiEndpointsPublicMarketplaceItemsGetMarketplaceItemByIdEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } }, { "name": "marketplaceInstanceId", "in": "query", "required": true, "schema": { "type": "string", "format": "guid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListedMarketplaceItem" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/marketplace-items/{marketplaceItemId}/downloads/{version}/access": { "get": { "tags": ["Downloads", "Marketplace"], "summary": "Check Download Eligibility", "description": "Confirms whether the requested device can download the marketplace artefact and returns the S3 access details when eligible.", "operationId": "InfusePlatformMarketplaceApiEndpointsPublicMarketplaceItemsGetMarketplaceItemDownloadAccessEndpoint", "parameters": [ { "name": "marketplaceItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceItemDownloadAccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/marketplace-items": { "get": { "tags": ["Marketplace Items", "Marketplace"], "summary": "List Items", "description": "Retrieves a list of all marketplace items.", "operationId": "InfusePlatformMarketplaceApiEndpointsPublicMarketplaceItemsGetMarketplaceItemsEndpoint", "parameters": [ { "name": "marketplaceInstanceId", "in": "query", "schema": { "type": "string", "format": "guid", "nullable": true } }, { "name": "type", "in": "query", "schema": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/MarketplaceItemTypeValue" } ] } }, { "name": "search", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListedMarketplaceItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/devices": { "get": { "tags": ["Devices", "Marketplace"], "summary": "Get provider devices", "description": "Returns Infuse IoT devices owned by the provider organisation linked to the active platform organisation.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersPurchasesGetProviderDevicesEndpoint", "parameters": [ { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderDevicesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/rpc/{rpcId}": { "get": { "tags": ["Rpc", "Marketplace"], "summary": "Get production install RPC status", "description": "Returns provider install RPC status for production install tracking.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersPurchasesGetProviderInstallRpcStatusEndpoint", "parameters": [ { "name": "rpcId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderInstallRpcStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/devices/{deviceId}/details": { "get": { "tags": ["Devices", "Marketplace"], "summary": "Get provider purchase device details", "description": "Returns Infuse IoT device metadata and state for a purchased device.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersPurchasesGetProviderPurchaseDeviceDetailsEndpoint", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderPurchaseDeviceDetailsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/devices/{deviceId}/purchases/{marketplaceItemId}/releases": { "get": { "tags": ["Devices", "Marketplace"], "summary": "Get provider purchase releases", "description": "Returns paginated releases with compatibility status for the provider's purchased marketplace item.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersPurchasesGetProviderPurchaseReleasesEndpoint", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplaceItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderPurchaseReleasesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/purchases": { "get": { "tags": ["Purchases", "Marketplace"], "summary": "Get provider purchases", "description": "Returns paginated purchase history for the provider's listed marketplace items.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersPurchasesGetProviderPurchasesEndpoint", "parameters": [ { "name": "deviceId", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderPurchasesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/purchases/activity": { "get": { "tags": ["Purchases", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersPurchasesGetProviderPurchaseActivityEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderPurchaseActivityResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/devices/{deviceId}/purchases/{marketplaceItemId}/install": { "post": { "tags": ["Devices", "Marketplace"], "summary": "Queue marketplace install", "description": "Queues an installation request for a marketplace item version on the specified device.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersPurchasesQueueProviderPurchaseInstallEndpoint", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "marketplaceItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } } ], "requestBody": { "x-name": "QueueProviderPurchaseInstallEndpointRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueProviderPurchaseInstallEndpointRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueProviderPurchaseInstallResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/marketplace-items/{id}": { "get": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Get Item", "description": "Fetches the core details of a specific marketplace item, including its type, organization, and creation timestamp.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersMarketplaceItemsGetMarketplaceItemByIdEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferedMarketplaceItem" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/marketplace-items": { "get": { "tags": ["Marketplace Items", "Marketplace"], "summary": "List Items", "description": "Retrieves a list of all marketplace items with basic summary information.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersMarketplaceItemsGetMarketplaceItemsEndpoint", "parameters": [ { "name": "marketplaceInstanceId", "in": "query", "schema": { "type": "string", "format": "guid", "nullable": true } }, { "name": "type", "in": "query", "schema": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/MarketplaceItemTypeValue" } ] } }, { "name": "search", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOfferedMarketplaceItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/listings/{marketplaceItemId}": { "post": { "tags": ["Listings", "Marketplace"], "summary": "Create Listing", "description": "Creates a new listing for the specified Marketplace Item.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersListingsCreateListingEndpoint", "parameters": [ { "name": "marketplaceItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "x-name": "CreateListingRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateListingRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateListingResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/listings/{marketplaceId}": { "get": { "tags": ["Listings", "Marketplace"], "summary": "Get Listing By Id", "description": "Fetches the details of a specific listing by its Marketplace Item ID.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersListingsGetListingByIdEndpoint", "parameters": [ { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } }, { "name": "marketplaceInstanceId", "in": "query", "required": true, "schema": { "type": "string", "format": "guid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceListing" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/listings/{marketplaceId}/history": { "get": { "tags": ["Listings", "Marketplace"], "summary": "Get Listing History", "description": "Returns all previous listings for the specified Marketplace Item.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersListingsGetPricingHistoryEndpoint", "parameters": [ { "name": "marketplaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } }, { "name": "marketplaceInstanceId", "in": "query", "required": true, "schema": { "type": "string", "format": "guid" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListingHistoryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/listings": { "get": { "tags": ["Listings", "Marketplace"], "summary": "Get Listings", "description": "Retrieves a list of all app listings with summary information.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersListingsGetListingsEndpoint", "parameters": [ { "name": "disabled", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "marketplaceInstanceId", "in": "query", "schema": { "type": "string", "format": "guid", "nullable": true } }, { "name": "type", "in": "query", "schema": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/MarketplaceItemTypeValue" } ] } }, { "name": "search", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetListingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/listings/{id}/visibility": { "post": { "tags": ["Listings", "Marketplace"], "summary": "Set Listing Visibility", "description": "Enables or disables the visibility of a specific app listing by appending a new visibility state.", "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersListingsSetListingVisibilityEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "x-name": "SetListingVisibilityRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetListingVisibilityRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/earnings/summary": { "get": { "tags": ["Earnings", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersEarningsGetProviderMarketplaceEarningsSummaryEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceEarningsSummaryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/earnings/timeseries": { "get": { "tags": ["Earnings", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersEarningsGetProviderMarketplaceEarningsTimeSeriesEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "interval", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/MarketplaceEarningsInterval" } ] } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceEarningsTimeSeriesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/providers/earnings/apps": { "get": { "tags": ["Earnings", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsProvidersEarningsGetProviderMarketplaceAppEarningsBreakdownEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceAppEarningsBreakdownResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/instances": { "post": { "tags": ["Instances", "Marketplace"], "summary": "Create Marketplace Instance", "description": "Registers a new marketplace instance.", "operationId": "InfusePlatformMarketplaceApiEndpointsMarketplaceInstancesCreateMarketplaceInstanceEndpoint", "requestBody": { "x-name": "CreateMarketplaceInstanceRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMarketplaceInstanceRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] }, "get": { "tags": ["Instances", "Marketplace"], "summary": "List Marketplace Instances", "description": "Retrieves marketplace instances for the current organisation.", "operationId": "InfusePlatformMarketplaceApiEndpointsMarketplaceInstancesGetMarketplaceInstancesEndpoint", "parameters": [ { "name": "type", "in": "query", "schema": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/MarketplaceInstanceTypeValue" } ] } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceInstancesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/instances/{identifier}": { "get": { "tags": ["Instances", "Marketplace"], "summary": "Get Marketplace Instance", "description": "Retrieves a marketplace instance by slug or identifier.", "operationId": "InfusePlatformMarketplaceApiEndpointsMarketplaceInstancesGetMarketplaceInstanceEndpoint", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstanceContractModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/earnings/access": { "get": { "tags": ["Access", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsEarningsGetMarketplaceEarningsAccessEndpoint", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceEarningsAccessResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/earnings/summary": { "get": { "tags": ["Summary", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsEarningsGetMarketplaceCombinedEarningsSummaryEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceEarningsSummaryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/earnings/timeseries": { "get": { "tags": ["Timeseries", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsEarningsGetMarketplaceCombinedEarningsTimeSeriesEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "interval", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/MarketplaceEarningsInterval" } ] } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceEarningsTimeSeriesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/earnings/apps": { "get": { "tags": ["Apps", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsEarningsGetMarketplaceCombinedAppEarningsBreakdownEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceCombinedAppEarningsBreakdownResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items": { "post": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Create Item", "description": "Registers a new marketplace item, which can be either an App or an Algorithm.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemCreateMarketplaceItemEndpoint", "requestBody": { "x-name": "CreateMarketplaceItemRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMarketplaceItemRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMarketplaceItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] }, "get": { "tags": ["Marketplace Items", "Marketplace"], "summary": "List Items", "description": "Retrieves a list of all marketplace items with basic summary information.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemGetMarketplaceItemsEndpoint", "parameters": [ { "name": "disabled", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "marketplaceInstanceId", "in": "query", "schema": { "type": "string", "format": "guid", "nullable": true } }, { "name": "type", "in": "query", "schema": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/MarketplaceItemTypeValue" } ] } }, { "name": "search", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDeveloperMarketplaceItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/releases": { "post": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Publish Release", "description": "Appends a new release to the specified marketplace item (app or algorithm) using the uploaded binary and manifest.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemCreateMarketplaceItemReleaseEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "x-name": "CreateMarketplaceItemReleaseRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMarketplaceItemReleaseRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] }, "get": { "tags": ["Marketplace Items", "Marketplace"], "summary": "List Releases", "description": "Retrieves the historical releases for a marketplace item, ordered by availability.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemGetMarketplaceItemReleasesEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDeveloperMarketplaceItemReleasesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}": { "get": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Get Item", "description": "Fetches the core details of a specific marketplace item, including its type, organization, and creation timestamp.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemGetMarketplaceItemByIdEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } }, { "name": "marketplaceInstanceId", "in": "query", "required": true, "schema": { "type": "string", "format": "guid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperMarketplaceItem" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/prices": { "get": { "tags": ["Marketplace Items", "Marketplace"], "summary": "List Prices", "description": "Retrieves the pricing history for a marketplace item, including the current base price.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemGetMarketplaceItemPricesEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDeveloperMarketplaceItemPricesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/images": { "get": { "tags": ["Marketplace Items", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemGetMarketplaceItemImagesEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceItemImage" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] }, "post": { "tags": ["Marketplace Items", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemAddMarketplaceItemImageEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } } ], "requestBody": { "x-name": "AddDeveloperMarketplaceItemImageRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddDeveloperMarketplaceItemImageRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceItemImage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/images/reorder": { "post": { "tags": ["Marketplace Items", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemReorderMarketplaceItemImagesEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "guid" } } ], "requestBody": { "x-name": "ReorderDeveloperMarketplaceItemImagesRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderDeveloperMarketplaceItemImagesRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceItemImage" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/images/{imageId}": { "delete": { "tags": ["Marketplace Items", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemDeleteMarketplaceItemImageEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "imageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/publish": { "post": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Publish Marketplace Item", "description": "Marks the item as published if all necessary details and files are complete.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemPublishMarketplaceItemEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/icon": { "post": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Set Icon", "description": "Associates a previously uploaded asset with the marketplace item icon.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemSetMarketplaceIconEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "x-name": "SetMarketplaceIconRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMarketplaceIconRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/metadata": { "post": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Set Metadata", "description": "Appends a new metadata record to the specified marketplace item, allowing updates to fields such as name and description.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemSetMarketplaceMetadataEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "x-name": "SetMarketplaceMetadataRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMarketplaceMetadataRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/price": { "post": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Set Price", "description": "Appends a new price row to the item. This does not update existing prices. The latest price is determined based on the EffectiveFrom timestamp.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemSetMarketplacePriceEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "x-name": "SetMarketplacePriceRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMarketplacePriceRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/marketplace-items/{id}/visibility": { "post": { "tags": ["Marketplace Items", "Marketplace"], "summary": "Set Visibility", "description": "Enables or disables the visibility of a specific marketplace item by appending a new visibility state.", "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersMarketplaceItemSetMarketplaceVisibilityEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "x-name": "SetMarketplaceVisibilityRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMarketplaceVisibilityRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/earnings/summary": { "get": { "tags": ["Earnings", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersEarningsGetDeveloperMarketplaceEarningsSummaryEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceEarningsSummaryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/earnings/timeseries": { "get": { "tags": ["Earnings", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersEarningsGetDeveloperMarketplaceEarningsTimeSeriesEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "interval", "in": "query", "required": true, "schema": { "allOf": [ { "$ref": "#/components/schemas/MarketplaceEarningsInterval" } ] } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceEarningsTimeSeriesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/developers/earnings/apps": { "get": { "tags": ["Earnings", "Marketplace"], "operationId": "InfusePlatformMarketplaceApiEndpointsDevelopersEarningsGetDeveloperMarketplaceAppEarningsBreakdownEndpoint", "parameters": [ { "name": "startUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "endUtc", "in": "query", "schema": { "type": "string", "format": "date-time", "nullable": true } }, { "name": "livemode", "in": "query", "schema": { "type": "boolean", "nullable": true } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string", "nullable": true } }, { "name": "direction", "in": "query", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceAppEarningsBreakdownResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/demo/providers/rpc/{rpcId}": { "get": { "tags": ["Providers", "Marketplace"], "summary": "Get demo install RPC status", "description": "Returns provider install RPC status for demo install tracking.", "operationId": "InfusePlatformMarketplaceApiEndpointsDemoPurchasesGetDemoProviderInstallRpcStatusEndpoint", "parameters": [ { "name": "rpcId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProviderInstallRpcStatusResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/demo/providers/devices/{deviceId}/install": { "post": { "tags": ["Providers", "Marketplace"], "summary": "Queue demo marketplace install", "description": "Queues a demo installation request for a configured demo resource on the specified device.", "operationId": "InfusePlatformMarketplaceApiEndpointsDemoPurchasesQueueDemoProviderPurchaseInstallEndpoint", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "x-name": "QueueDemoProviderPurchaseInstallEndpointRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueDemoProviderPurchaseInstallEndpointRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueDemoProviderPurchaseInstallResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } }, "/marketplace/checkout/session": { "post": { "tags": ["Session", "Marketplace"], "summary": "Create checkout session", "description": "Creates a checkout session for the provided devices and marketplace items.", "operationId": "InfusePlatformMarketplaceApiEndpointsCheckoutCreateCheckoutSessionEndpoint", "requestBody": { "x-name": "CreateCheckoutSessionRequest", "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCheckoutSessionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCheckoutSessionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails2" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "Bearer": [] }, { "DirectApiKey": [] } ] } } }, "components": { "schemas": { "GetMarketplaceSettlementStatementsResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfMarketplaceSettlementStatementSummaryDto" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfMarketplaceSettlementStatementSummaryDto": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceSettlementStatementSummaryDto" } } } }, "MarketplaceSettlementStatementSummaryDto": { "type": "object", "additionalProperties": false, "properties": { "statementId": { "type": "string", "format": "guid" }, "reference": { "type": "string" }, "payeeOrganisationId": { "type": "string", "format": "guid" }, "payeeOrganisationName": { "type": "string" }, "role": { "type": "string" }, "currency": { "type": "string" }, "periodStartUtc": { "type": "string", "format": "date-time" }, "periodEndUtc": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "livemode": { "type": "boolean" }, "batchId": { "type": "string", "format": "guid", "nullable": true }, "payoutId": { "type": "string", "format": "guid", "nullable": true }, "openingUnpaidBalance": { "type": "number", "format": "decimal" }, "periodSalesAmount": { "type": "number", "format": "decimal" }, "periodRefundAmount": { "type": "number", "format": "decimal" }, "periodNetAmount": { "type": "number", "format": "decimal" }, "amountIncludedInPayout": { "type": "number", "format": "decimal" }, "paidAmount": { "type": "number", "format": "decimal" }, "closingUnpaidBalance": { "type": "number", "format": "decimal" }, "paidAtUtc": { "type": "string", "format": "date-time", "nullable": true } } }, "ProblemDetails": { "type": "object", "additionalProperties": { "nullable": true }, "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } } }, "GetMarketplaceSettlementStatementsRequest": { "allOf": [ { "$ref": "#/components/schemas/PagedRequest" }, { "type": "object", "additionalProperties": false } ] }, "MarketplaceSettlementStatementRoleFilter": { "type": "string", "description": "", "x-enumNames": ["All", "Developer", "Provider"], "enum": ["all", "developer", "provider"] }, "MarketplaceSettlementStatementStatusFilter": { "type": "string", "description": "", "x-enumNames": ["All", "Draft", "Finalized", "Paid", "PartiallyPaid"], "enum": ["all", "draft", "finalized", "paid", "partiallyPaid"] }, "PagedRequest": { "type": "object", "additionalProperties": false }, "ProblemDetails2": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "default": "https://www.rfc-editor.org/rfc/rfc7231#section-6.5.1" }, "title": { "type": "string", "default": "One or more validation errors occurred." }, "status": { "type": "integer", "format": "int32", "default": 400 }, "instance": { "type": "string", "default": "/api/route" }, "traceId": { "type": "string", "default": "0HMPNHL0JHL76:00000001" }, "detail": { "type": "string", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ProblemDetails_Error" } } } }, "ProblemDetails_Error": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "default": "Error or field name" }, "reason": { "type": "string", "default": "Error reason" }, "code": { "type": "string", "nullable": true }, "severity": { "type": "string", "nullable": true } } }, "GetMarketplaceSettlementStatementByIdResponse": { "type": "object", "additionalProperties": false, "properties": { "statementId": { "type": "string", "format": "guid" }, "reference": { "type": "string" }, "payeeOrganisationId": { "type": "string", "format": "guid" }, "payeeOrganisationName": { "type": "string" }, "role": { "type": "string" }, "currency": { "type": "string" }, "status": { "type": "string" }, "livemode": { "type": "boolean" }, "periodStartUtc": { "type": "string", "format": "date-time" }, "periodEndUtc": { "type": "string", "format": "date-time" }, "batchId": { "type": "string", "format": "guid", "nullable": true }, "payoutId": { "type": "string", "format": "guid", "nullable": true }, "openingUnpaidBalance": { "type": "number", "format": "decimal" }, "periodSalesAmount": { "type": "number", "format": "decimal" }, "periodRefundAmount": { "type": "number", "format": "decimal" }, "periodNetAmount": { "type": "number", "format": "decimal" }, "amountIncludedInPayout": { "type": "number", "format": "decimal" }, "paidAmount": { "type": "number", "format": "decimal" }, "closingUnpaidBalance": { "type": "number", "format": "decimal" }, "paidAtUtc": { "type": "string", "format": "date-time", "nullable": true }, "paymentReference": { "type": "string", "nullable": true }, "paymentMethod": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceSettlementStatementLineGroupDto" } }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceSettlementStatementTransactionDto" } } } }, "MarketplaceSettlementStatementLineGroupDto": { "type": "object", "additionalProperties": false, "properties": { "marketplaceItemId": { "type": "string", "format": "guid" }, "marketplaceItemName": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "salesAmount": { "type": "number", "format": "decimal" }, "refundAmount": { "type": "number", "format": "decimal" }, "netAmount": { "type": "number", "format": "decimal" }, "paidAmount": { "type": "number", "format": "decimal" }, "pendingAmount": { "type": "number", "format": "decimal" }, "livemode": { "type": "boolean" } } }, "MarketplaceSettlementStatementTransactionDto": { "type": "object", "additionalProperties": false, "properties": { "earningEntryId": { "type": "string", "format": "guid" }, "marketplaceItemId": { "type": "string", "format": "guid" }, "marketplaceItemName": { "type": "string" }, "entitlementId": { "type": "string", "format": "guid" }, "entryType": { "type": "string" }, "eventAtUtc": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "decimal" }, "payoutStatus": { "type": "string" }, "livemode": { "type": "boolean" } } }, "GetMarketplaceSettlementStatementByIdEndpointRequest": { "type": "object", "additionalProperties": false }, "GetMarketplaceSettlementStatementExportEndpointRequest": { "type": "object", "additionalProperties": false }, "ListedMarketplaceItem": { "allOf": [ { "$ref": "#/components/schemas/BaseMarketplaceItem" }, { "type": "object", "additionalProperties": false, "properties": { "latestVersion": { "type": "string" } } } ] }, "BaseMarketplaceItem": { "type": "object", "additionalProperties": false, "properties": { "marketplaceItemId": { "type": "string", "format": "guid" }, "developerProfile": { "$ref": "#/components/schemas/MarketplaceItemDeveloperProfile" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "iconAssetId": { "type": "string", "format": "guid", "nullable": true }, "iconUrl": { "type": "string", "nullable": true }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceItemImage" } }, "visible": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "type": { "$ref": "#/components/schemas/MarketplaceItemTypeValue" }, "algorithmType": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/MarketplaceItemStatusType" }, "price": { "type": "number", "format": "decimal" }, "eulaUrl": { "type": "string", "nullable": true }, "licenseUrl": { "type": "string", "nullable": true } } }, "MarketplaceItemDeveloperProfile": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "guid" }, "name": { "type": "string" }, "profilePictureUrl": { "type": "string", "nullable": true } } }, "MarketplaceItemImage": { "type": "object", "additionalProperties": false, "properties": { "imageId": { "type": "string", "format": "guid" }, "assetId": { "type": "string", "format": "guid" }, "url": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "width": { "type": "integer", "format": "int32", "nullable": true }, "height": { "type": "integer", "format": "int32", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } } }, "MarketplaceItemTypeValue": { "type": "string", "description": "", "x-enumNames": ["App", "Algorithm"], "enum": ["app", "algorithm"] }, "MarketplaceItemStatusType": { "type": "string", "description": "", "x-enumNames": ["Draft", "PendingReview", "Published"], "enum": ["draft", "pending_review", "published"] }, "GetListedMarketplaceItemByIdRequest": { "type": "object", "additionalProperties": false }, "GetMarketplaceItemDownloadAccessResponse": { "type": "object", "additionalProperties": false, "properties": { "artefactId": { "type": "string", "format": "guid" }, "s3Key": { "type": "string" }, "sha256": { "type": "string", "nullable": true }, "size": { "type": "integer", "format": "int64" }, "eTag": { "type": "string" } } }, "GetMarketplaceItemDownloadAccessRequest": { "type": "object", "additionalProperties": false }, "GetListedMarketplaceItemsResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfListedMarketplaceItem" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfListedMarketplaceItem": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListedMarketplaceItem" } } } }, "GetListedMarketplaceItemsRequest": { "allOf": [ { "$ref": "#/components/schemas/BasePagedMarketplaceItemsRequest" }, { "type": "object", "additionalProperties": false } ] }, "BasePagedMarketplaceItemsRequest": { "allOf": [ { "$ref": "#/components/schemas/PagedRequest" }, { "type": "object", "additionalProperties": false } ] }, "GetProviderDevicesResponse": { "type": "object", "additionalProperties": false, "properties": { "limit": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderDeviceLookupDto" } } } }, "ProviderDeviceLookupDto": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "deviceId": { "type": "string" }, "name": { "type": "string", "nullable": true } } }, "GetProviderDevicesRequest": { "type": "object", "additionalProperties": false }, "GetProviderInstallRpcStatusResponse": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "downlinkMessageId": { "type": "string", "nullable": true }, "deviceId": { "type": "string" }, "requestCommandName": { "type": "string", "nullable": true }, "response": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "rawJson": { "type": "string", "nullable": true } } }, "GetProviderInstallRpcStatusEndpointRequest": { "type": "object", "additionalProperties": false }, "GetProviderPurchaseDeviceDetailsResponse": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deviceId": { "type": "string" }, "boardId": { "type": "string" }, "organisationId": { "type": "string" }, "mcuId": { "type": "string" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "metadata": { "type": "object", "nullable": true, "additionalProperties": { "type": "string" } }, "initialDeviceState": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ProviderPurchaseDeviceStateDto" } ] } } }, "ProviderPurchaseDeviceStateDto": { "type": "object", "additionalProperties": false, "properties": { "applicationId": { "type": "integer", "format": "int32", "nullable": true }, "applicationVersion": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ProviderPurchaseApplicationVersionDto" } ] }, "algorithms": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderPurchaseAlgorithmDto" } }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true } } }, "ProviderPurchaseApplicationVersionDto": { "type": "object", "additionalProperties": false, "properties": { "major": { "type": "integer", "format": "int32" }, "minor": { "type": "integer", "format": "int32" }, "revision": { "type": "integer", "format": "int32" }, "buildNum": { "type": "integer", "format": "int32" } } }, "ProviderPurchaseAlgorithmDto": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "format": "int32" }, "version": { "type": "integer", "format": "int32" } } }, "GetProviderPurchaseDeviceDetailsRequest": { "type": "object", "additionalProperties": false }, "GetProviderPurchaseReleasesResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfProviderPurchaseReleaseDto" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfProviderPurchaseReleaseDto": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderPurchaseReleaseDto" } } } }, "ProviderPurchaseReleaseDto": { "type": "object", "additionalProperties": false, "properties": { "releaseId": { "type": "string", "format": "guid" }, "versionLabel": { "type": "string" }, "availableFrom": { "type": "string", "format": "date-time" }, "changeLog": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "isCompatible": { "type": "boolean" }, "isInstalled": { "type": "boolean" } } }, "GetProviderPurchaseReleasesRequest": { "allOf": [ { "$ref": "#/components/schemas/PagedRequest" }, { "type": "object", "additionalProperties": false } ] }, "GetProviderPurchasesResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfProviderPurchaseDto" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfProviderPurchaseDto": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderPurchaseDto" } } } }, "ProviderPurchaseDto": { "type": "object", "additionalProperties": false, "properties": { "purchaseId": { "type": "string", "format": "guid" }, "deviceId": { "type": "string" }, "status": { "$ref": "#/components/schemas/MarketplacePurchaseStatus" }, "unitPrice": { "type": "number", "format": "decimal" }, "totalAmountPaid": { "type": "number", "format": "decimal" }, "providerListingMarkup": { "type": "number", "format": "decimal" }, "currency": { "type": "string" }, "marketplaceItem": { "$ref": "#/components/schemas/ProviderPurchaseMarketplaceItemDto" }, "paymentProvider": { "type": "string", "nullable": true }, "sessionId": { "type": "string", "format": "guid", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "activatedAt": { "type": "string", "format": "date-time", "nullable": true }, "revokedAt": { "type": "string", "format": "date-time", "nullable": true }, "refundedAt": { "type": "string", "format": "date-time", "nullable": true }, "sessionConfirmedAt": { "type": "string", "format": "date-time", "nullable": true }, "sessionCancelledAt": { "type": "string", "format": "date-time", "nullable": true }, "livemode": { "type": "boolean" } } }, "MarketplacePurchaseStatus": { "type": "string", "description": "", "x-enumNames": ["Pending", "Active", "Revoked", "Refunded"], "enum": ["pending", "active", "revoked", "refunded"] }, "ProviderPurchaseMarketplaceItemDto": { "type": "object", "additionalProperties": false, "properties": { "marketplaceItemId": { "type": "string", "format": "guid" }, "name": { "type": "string" }, "listingId": { "type": "string", "format": "guid", "nullable": true }, "offeringId": { "type": "string", "format": "guid", "nullable": true } } }, "GetProviderPurchasesRequest": { "allOf": [ { "$ref": "#/components/schemas/PagedRequest" }, { "type": "object", "additionalProperties": false } ] }, "GetProviderPurchaseActivityResponse": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderPurchaseActivityDto" } } } }, "ProviderPurchaseActivityDto": { "type": "object", "additionalProperties": false, "properties": { "purchaseId": { "type": "string", "format": "guid" }, "eventType": { "$ref": "#/components/schemas/ProviderPurchaseActivityEventType" }, "eventAtUtc": { "type": "string", "format": "date-time" }, "marketplaceItemId": { "type": "string", "format": "guid" }, "marketplaceItemName": { "type": "string" }, "currency": { "type": "string" }, "grossAmount": { "type": "number", "format": "decimal" }, "providerMarkupAmount": { "type": "number", "format": "decimal" }, "livemode": { "type": "boolean" } } }, "ProviderPurchaseActivityEventType": { "type": "string", "description": "", "x-enumNames": ["Purchase", "Refund"], "enum": ["purchase", "refund"] }, "GetProviderPurchaseActivityRequest": { "type": "object", "additionalProperties": false }, "QueueProviderPurchaseInstallResponse": { "type": "object", "additionalProperties": false, "properties": { "rpcId": { "type": "string" } } }, "QueueProviderPurchaseInstallEndpointRequest": { "type": "object", "additionalProperties": false, "required": ["version"], "properties": { "version": { "type": "string", "minLength": 1, "nullable": false } } }, "OfferedMarketplaceItem": { "allOf": [ { "$ref": "#/components/schemas/BaseMarketplaceItem" }, { "type": "object", "additionalProperties": false, "properties": { "latestVersion": { "type": "string" } } } ] }, "GetOfferedMarketplaceItemByIdRequest": { "type": "object", "additionalProperties": false }, "GetOfferedMarketplaceItemsResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfOfferedMarketplaceItem" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfOfferedMarketplaceItem": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OfferedMarketplaceItem" } } } }, "GetOfferedMarketplaceItemsRequest": { "allOf": [ { "$ref": "#/components/schemas/BasePagedMarketplaceItemsRequest" }, { "type": "object", "additionalProperties": false } ] }, "CreateListingResponse": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" } } }, "CreateListingRequest": { "type": "object", "additionalProperties": false, "required": ["marketplaceInstanceId"], "properties": { "marketplaceInstanceId": { "type": "string", "minLength": 1, "nullable": false }, "markupAmount": { "type": "number", "format": "decimal", "minimum": 0 } } }, "MarketplaceListing": { "type": "object", "additionalProperties": false, "properties": { "listingId": { "type": "string", "format": "guid" }, "providerId": { "type": "string", "format": "guid" }, "marketplaceItem": { "$ref": "#/components/schemas/BaseMarketplaceItem" }, "createdBy": { "type": "string", "format": "guid" }, "createdAt": { "type": "string", "format": "date-time" }, "markupAmount": { "type": "number", "format": "decimal" }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true }, "disabledBy": { "type": "string", "format": "guid", "nullable": true }, "listedPrice": { "type": "number", "format": "decimal" }, "markupPercentage": { "type": "number", "format": "decimal", "nullable": true } } }, "GetListingByMarketplaceIdRequest": { "type": "object", "additionalProperties": false }, "GetListingHistoryResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfListingHistoryDto" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfListingHistoryDto": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListingHistoryDto" } } } }, "ListingHistoryDto": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "guid" }, "createdAt": { "type": "string", "format": "date-time" }, "markupAmount": { "type": "number", "format": "decimal" }, "createdBy": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UserProfile" } ] }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true }, "isDisabled": { "type": "boolean" } } }, "UserProfile": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "guid" }, "name": { "type": "string", "nullable": true }, "profilePictureUrl": { "type": "string", "nullable": true } } }, "GetListingHistoryRequest": { "allOf": [ { "$ref": "#/components/schemas/PagedRequest" }, { "type": "object", "additionalProperties": false } ] }, "GetListingsResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfMarketplaceListing" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfMarketplaceListing": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceListing" } } } }, "GetListingsRequest": { "allOf": [ { "$ref": "#/components/schemas/BasePagedMarketplaceItemsRequest" }, { "type": "object", "additionalProperties": false } ] }, "SetListingVisibilityRequest": { "type": "object", "additionalProperties": false, "required": ["visible"], "properties": { "visible": { "type": "boolean", "nullable": false } } }, "GetMarketplaceEarningsSummaryResponse": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceCurrencyEarningsSummaryDto" } } } }, "MarketplaceCurrencyEarningsSummaryDto": { "type": "object", "additionalProperties": false, "properties": { "currency": { "type": "string" }, "pendingAmount": { "type": "number", "format": "decimal" }, "paidAmount": { "type": "number", "format": "decimal" }, "totalNetAmount": { "type": "number", "format": "decimal" } } }, "GetMarketplaceEarningsSummaryRequest": { "type": "object", "additionalProperties": false }, "GetMarketplaceEarningsTimeSeriesResponse": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceCurrencyEarningsTimeSeriesDto" } } } }, "MarketplaceCurrencyEarningsTimeSeriesDto": { "type": "object", "additionalProperties": false, "properties": { "currency": { "type": "string" }, "totalNetAmount": { "type": "number", "format": "decimal" }, "buckets": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceEarningsTimeSeriesBucketDto" } } } }, "MarketplaceEarningsTimeSeriesBucketDto": { "type": "object", "additionalProperties": false, "properties": { "bucketStartUtc": { "type": "string", "format": "date-time" }, "bucketEndUtc": { "type": "string", "format": "date-time" }, "netAmount": { "type": "number", "format": "decimal" } } }, "GetMarketplaceEarningsTimeSeriesRequest": { "type": "object", "additionalProperties": false }, "MarketplaceEarningsInterval": { "type": "string", "description": "", "x-enumNames": ["Daily", "Weekly", "Monthly"], "enum": ["daily", "weekly", "monthly"] }, "GetMarketplaceAppEarningsBreakdownResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfMarketplaceAppEarningsBreakdownDto" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfMarketplaceAppEarningsBreakdownDto": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceAppEarningsBreakdownDto" } } } }, "MarketplaceAppEarningsBreakdownDto": { "type": "object", "additionalProperties": false, "properties": { "marketplaceItemId": { "type": "string", "format": "guid" }, "marketplaceItemName": { "type": "string" }, "currency": { "type": "string" }, "pendingAmount": { "type": "number", "format": "decimal" }, "paidAmount": { "type": "number", "format": "decimal" }, "totalNetAmount": { "type": "number", "format": "decimal" } } }, "GetMarketplaceAppEarningsBreakdownRequest": { "allOf": [ { "$ref": "#/components/schemas/PagedRequest" }, { "type": "object", "additionalProperties": false } ] }, "CreateMarketplaceInstanceRequest": { "type": "object", "additionalProperties": false, "required": ["name"], "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 0, "nullable": false }, "type": { "$ref": "#/components/schemas/MarketplaceInstanceTypeValue" } } }, "MarketplaceInstanceTypeValue": { "type": "string", "description": "", "x-enumNames": ["Developer", "Provider"], "enum": ["developer", "provider"] }, "MarketplaceInstanceContractModel": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "guid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "type": { "$ref": "#/components/schemas/MarketplaceInstanceTypeValue" } } }, "GetMarketplaceInstanceByIdentifierRequest": { "type": "object", "additionalProperties": false }, "GetMarketplaceInstancesResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfMarketplaceInstanceContractModel" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfMarketplaceInstanceContractModel": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceInstanceContractModel" } } } }, "GetMarketplaceInstancesRequest": { "allOf": [ { "$ref": "#/components/schemas/PagedRequest" }, { "type": "object", "additionalProperties": false } ] }, "GetMarketplaceEarningsAccessResponse": { "type": "object", "additionalProperties": false, "properties": { "canRead": { "type": "boolean" } } }, "GetMarketplaceCombinedAppEarningsBreakdownResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfMarketplaceCombinedAppEarningsBreakdownDto" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfMarketplaceCombinedAppEarningsBreakdownDto": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceCombinedAppEarningsBreakdownDto" } } } }, "MarketplaceCombinedAppEarningsBreakdownDto": { "type": "object", "additionalProperties": false, "properties": { "marketplaceItemId": { "type": "string", "format": "guid" }, "marketplaceItemName": { "type": "string" }, "role": { "type": "string" }, "currency": { "type": "string" }, "pendingAmount": { "type": "number", "format": "decimal" }, "paidAmount": { "type": "number", "format": "decimal" }, "totalNetAmount": { "type": "number", "format": "decimal" } } }, "CreateMarketplaceItemResponse": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string" }, "organisationId": { "type": "string" }, "marketplaceInstanceId": { "type": "string" }, "type": { "$ref": "#/components/schemas/MarketplaceItemType" }, "createdAt": { "type": "string", "format": "date-time" } } }, "MarketplaceItemType": { "type": "string", "description": "", "x-enumNames": ["App", "Algorithm"], "enum": ["app", "algorithm"] }, "CreateMarketplaceItemRequest": { "type": "object", "additionalProperties": false, "required": ["marketplaceInstanceId", "name"], "properties": { "marketplaceInstanceId": { "type": "string", "format": "guid", "minLength": 1, "nullable": false }, "type": { "$ref": "#/components/schemas/MarketplaceItemType" }, "name": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": false } } }, "CreateMarketplaceItemReleaseRequest": { "type": "object", "additionalProperties": false, "properties": { "binaryAssetId": { "type": "string" }, "manifestAssetId": { "type": "string" }, "availableFrom": { "type": "string", "format": "date-time", "nullable": true }, "changeLog": { "type": "string", "nullable": true } } }, "DeveloperMarketplaceItem": { "allOf": [ { "$ref": "#/components/schemas/BaseMarketplaceItem" }, { "type": "object", "additionalProperties": false, "properties": { "displayName": { "type": "string", "nullable": true }, "disabledAt": { "type": "string", "format": "date-time", "nullable": true }, "latestVersion": { "type": "string", "nullable": true } } } ] }, "GetDeveloperMarketplaceItemByIdRequest": { "type": "object", "additionalProperties": false }, "GetDeveloperMarketplaceItemPricesResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfMarketplaceItemPriceHistory" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfMarketplaceItemPriceHistory": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceItemPriceHistory" } } } }, "MarketplaceItemPriceHistory": { "type": "object", "additionalProperties": false, "properties": { "priceId": { "type": "string", "format": "guid" }, "price": { "type": "number", "format": "decimal" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UserProfile" } ] }, "isCurrent": { "type": "boolean" } } }, "GetDeveloperMarketplaceItemPricesRequest": { "allOf": [ { "$ref": "#/components/schemas/PagedRequest" }, { "type": "object", "additionalProperties": false } ] }, "GetDeveloperMarketplaceItemReleasesResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfMarketplaceItemReleaseSummary" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfMarketplaceItemReleaseSummary": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceItemReleaseSummary" } } } }, "MarketplaceItemReleaseSummary": { "type": "object", "additionalProperties": false, "properties": { "releaseId": { "type": "string", "format": "guid" }, "versionLabel": { "type": "string" }, "availableFrom": { "type": "string", "format": "date-time" }, "changeLog": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } } }, "GetDeveloperMarketplaceItemReleasesRequest": { "allOf": [ { "$ref": "#/components/schemas/PagedRequest" }, { "type": "object", "additionalProperties": false } ] }, "GetDeveloperMarketplaceItemsResponse": { "allOf": [ { "$ref": "#/components/schemas/PagedResponseOfDeveloperMarketplaceItem" }, { "type": "object", "additionalProperties": false } ] }, "PagedResponseOfDeveloperMarketplaceItem": { "type": "object", "additionalProperties": false, "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DeveloperMarketplaceItem" } } } }, "GetDeveloperMarketplaceItemsRequest": { "allOf": [ { "$ref": "#/components/schemas/BasePagedMarketplaceItemsRequest" }, { "type": "object", "additionalProperties": false } ] }, "GetDeveloperMarketplaceItemImagesRequest": { "type": "object", "additionalProperties": false }, "AddDeveloperMarketplaceItemImageRequest": { "type": "object", "additionalProperties": false, "required": ["assetId"], "properties": { "assetId": { "type": "string", "format": "guid", "minLength": 1, "nullable": false } } }, "ReorderDeveloperMarketplaceItemImagesRequest": { "type": "object", "additionalProperties": false, "required": ["imageIds"], "properties": { "imageIds": { "type": "array", "minLength": 1, "nullable": false, "items": { "type": "string", "format": "guid" } } } }, "PublishMarketplaceItemRequest": { "type": "object", "additionalProperties": false }, "SetMarketplaceIconRequest": { "type": "object", "additionalProperties": false, "properties": { "iconAssetId": { "type": "string" } } }, "SetMarketplaceMetadataRequest": { "type": "object", "additionalProperties": false, "required": ["displayName"], "properties": { "displayName": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": false }, "description": { "type": "string", "maxLength": 2000, "minLength": 0, "nullable": true }, "algorithmType": { "type": "string", "maxLength": 200, "minLength": 0, "nullable": true }, "licenseUrl": { "type": "string", "maxLength": 500, "minLength": 0, "nullable": true }, "eulaUrl": { "type": "string", "maxLength": 500, "minLength": 0, "nullable": true } } }, "SetMarketplacePriceRequest": { "type": "object", "additionalProperties": false, "properties": { "price": { "type": "number", "format": "decimal", "minimum": 0, "exclusiveMinimum": true } } }, "SetMarketplaceVisibilityRequest": { "type": "object", "additionalProperties": false, "required": ["visible"], "properties": { "visible": { "type": "boolean", "nullable": false } } }, "GetDemoProviderInstallRpcStatusEndpointRequest": { "type": "object", "additionalProperties": false }, "QueueDemoProviderPurchaseInstallResponse": { "type": "object", "additionalProperties": false, "properties": { "rpcId": { "type": "string" } } }, "QueueDemoProviderPurchaseInstallEndpointRequest": { "type": "object", "additionalProperties": false, "required": ["resourceKey"], "properties": { "resourceKey": { "type": "string", "minLength": 1, "nullable": false }, "version": { "type": "string", "nullable": true }, "profile": { "type": "string", "nullable": true } } }, "CreateCheckoutSessionResponse": { "type": "object", "additionalProperties": false, "properties": { "checkoutSessionId": { "type": "string", "format": "guid" }, "checkoutUrl": { "type": "string", "nullable": true }, "livemode": { "type": "boolean" } } }, "CreateCheckoutSessionRequest": { "type": "object", "additionalProperties": false, "required": ["deviceIds", "marketplaceItemIds", "successUrl", "cancelUrl"], "properties": { "deviceIds": { "type": "array", "minItems": 1, "nullable": false, "items": { "type": "string" } }, "marketplaceItemIds": { "type": "array", "minItems": 1, "nullable": false, "items": { "type": "string", "format": "guid" } }, "successUrl": { "type": "string", "format": "uri", "maxLength": 1024, "minLength": 1, "nullable": false }, "cancelUrl": { "type": "string", "format": "uri", "maxLength": 1024, "minLength": 1, "nullable": false }, "livemode": { "type": "boolean" } } } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Authorization: Bearer ", "scheme": "bearer", "bearerFormat": "JWT" }, "DirectApiKey": { "type": "apiKey", "description": "Authorization: ApiKey ik_.", "name": "Authorization", "in": "header" } } }, "x-tagGroups": [ { "name": "Webhooks", "tags": ["Stripe"] }, { "name": "Earnings", "tags": ["Access", "Apps", "Statements", "Summary", "Timeseries"] }, { "name": "Marketplace Items", "tags": ["Downloads", "Marketplace Items"] }, { "name": "Providers", "tags": ["Devices", "Earnings", "Listings", "Marketplace Items", "Purchases", "Rpc"] }, { "name": "Instances", "tags": ["Instances"] }, { "name": "Developers", "tags": ["Earnings", "Marketplace Items"] }, { "name": "Demo", "tags": ["Providers"] }, { "name": "Checkout", "tags": ["Session"] } ] }