OtherServiceProvider
Type: schema
TypeScript Definition
typescript
OtherServiceProvider: {{
id?: $Read<string>;
name?: $Read<string>;
alias?: $Read<string>;
/** @description Primary logo URL. Same as `logo_light` for most providers. */
logo?: $Read<string | null>;
service_sub_type?: $Read<string | null>;
service_type?: $Read<components["schemas"]["ServiceProviderType"]>;
description?: $Read<string>;
short_description?: $Read<string>;
logo_dark?: $Read<string | null>;
logo_light?: $Read<string | null>;
website_url?: $Read<string | null>;
api_doc_url?: $Read<string | null>;
/** @description json object in key & value pair. */
required_credentials_params?: $Read<{
input_field_name?: string;
input_field_label?: string;
/** @enum {unknown} */
input_field_type?: "text" | "number" | "boolean" | "email" | "password";
}[]>;
/** @default false */
is_connected: $Read<boolean>;
/** @default true */
is_connection_expired: $Read<boolean>;
/** @default true */
supports_test_connection: $Read<boolean>;
/** @description Connected credential values. Keys match `required_credentials_params[].input_field_name`. Returned as `null`, or as an empty array `[]`, when the provider has no stored credentials. */
api_credentials?: $Read<{
[key: string]: unknown;
} | unknown[] | null>;
/**
* @default active
* @enum {unknown}
*/
status: "active" | "inactive" | "error";
features?: $Read<{
name?: string;
description?: string;
is_supported?: boolean;
features?: {
name?: string;
description?: string;
is_supported?: boolean;
}[];
}[]>;
};
/**
* Packaging
* @description Packing dimensions for a product without variants. `null` when the product has variants, or when no packaging is configured.
*/
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["ServiceProviderType"] | ServiceProviderType |
OpenAPI Schema
json
{
"title": "OtherServiceProvider",
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"alias": {
"type": "string",
"readOnly": true
},
"logo": {
"description": "Primary logo URL. Same as `logo_light` for most providers.",
"type": [
"string",
"null"
],
"readOnly": true
},
"service_sub_type": {
"type": [
"string",
"null"
],
"readOnly": true
},
"service_type": {
"$ref": "#/components/schemas/ServiceProviderType",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
},
"short_description": {
"type": "string",
"readOnly": true
},
"logo_dark": {
"type": [
"string",
"null"
],
"readOnly": true
},
"logo_light": {
"type": [
"string",
"null"
],
"readOnly": true
},
"website_url": {
"type": [
"string",
"null"
],
"readOnly": true
},
"api_doc_url": {
"type": [
"string",
"null"
],
"readOnly": true
},
"required_credentials_params": {
"description": "json object in key & value pair.",
"type": "array",
"items": {
"type": "object",
"properties": {
"input_field_name": {
"type": "string"
},
"input_field_label": {
"type": "string"
},
"input_field_type": {
"enum": [
"text",
"number",
"boolean",
"email",
"password"
]
}
}
},
"readOnly": true
},
"is_connected": {
"type": "boolean",
"default": false,
"readOnly": true
},
"is_connection_expired": {
"type": "boolean",
"default": true,
"readOnly": true
},
"supports_test_connection": {
"type": "boolean",
"default": true,
"readOnly": true
},
"api_credentials": {
"description": "Connected credential values. Keys match `required_credentials_params[].input_field_name`. Returned as `null`, or as an empty array `[]`, when the provider has no stored credentials.",
"type": [
"object",
"array",
"null"
],
"additionalProperties": true,
"readOnly": true
},
"status": {
"default": "active",
"enum": [
"active",
"inactive",
"error"
]
},
"features": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_supported": {
"type": "boolean"
},
"features": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_supported": {
"type": "boolean"
}
}
}
}
}
},
"readOnly": true
}
},
"x-tags": [
"Store"
]
}Auto-generated from OpenAPI spec and TypeScript definitions