@bfra.me/api-core 0.1.0 → 0.1.2

package/test-utils/sdks/alby/src/schemas/KeyResponse.ts

@@ -1,63 +0,0 @@
-const KeyResponse = {
-  "additionalProperties": false,
-  "properties": {
-    "appId": {
-      "description": "The Ably application ID which this key is associated with.",
-      "type": "string",
-      "examples": [
-        "28GY6a"
-      ]
-    },
-    "capability": {
-      "additionalProperties": {
-        "items": {
-          "enum": [
-            "publish",
-            "subscribe",
-            "history",
-            "presence",
-            "channel-metadata",
-            "push-admin",
-            "push-subscribe",
-            "statistics"
-          ],
-          "type": "string",
-          "description": "`publish` `subscribe` `history` `presence` `channel-metadata` `push-admin` `push-subscribe` `statistics`"
-        },
-        "type": "array"
-      },
-      "description": "The capabilities that this key has. More information on capabilities can be found in the <a href=\"https://ably.com/documentation/core-features/authentication#capabilities-explained\">Ably documentation</a>.",
-      "type": "object"
-    },
-    "created": {
-      "description": "Unix timestamp representing the date and time of creation of the key.",
-      "type": "integer",
-      "examples": [
-        1602844091815
-      ]
-    },
-    "id": {
-      "description": "The key ID.",
-      "type": "string"
-    },
-    "key": {
-      "description": "The complete API key including API secret.",
-      "type": "string"
-    },
-    "modified": {
-      "description": "Unix timestamp representing the date and time of the last modification of the key.",
-      "type": "integer",
-      "examples": [
-        1614679682091
-      ]
-    },
-    "name": {
-      "description": "The name of the application this key is associated with.",
-      "type": "string"
-    }
-  },
-  "type": "object",
-  "title": "key_response",
-  "x-readme-ref-name": "key_response"
-} as const;
-export default KeyResponse

package/test-utils/sdks/alby/src/schemas/Me.ts

@@ -1,98 +0,0 @@
-const Me = {
-  "additionalProperties": false,
-  "properties": {
-    "account": {
-      "additionalProperties": false,
-      "properties": {
-        "id": {
-          "description": "The account ID.",
-          "type": "string",
-          "examples": [
-            "VpWaOA"
-          ]
-        },
-        "name": {
-          "description": "The name of the account.",
-          "type": "string",
-          "examples": [
-            "Free account"
-          ]
-        }
-      },
-      "required": [
-        "id",
-        "name"
-      ],
-      "type": "object"
-    },
-    "token": {
-      "additionalProperties": false,
-      "properties": {
-        "capabilities": {
-          "description": "An array containing the access capabilities associated with the access token.",
-          "items": {
-            "type": "string"
-          },
-          "type": "array",
-          "examples": [
-            "write:namespace",
-            "read:namespace",
-            "write:queue",
-            "read:queue",
-            "write:rule",
-            "read:rule",
-            "write:key",
-            "read:key",
-            "write:app",
-            "read:app"
-          ]
-        },
-        "id": {
-          "description": "The token ID. This is a UUID.",
-          "type": "integer",
-          "examples": [
-            "C95837C9-184B-4CC2-8779-B769F960FADB"
-          ]
-        },
-        "name": {
-          "description": "The friendly name for the token.",
-          "type": "string",
-          "examples": [
-            "My Token"
-          ]
-        }
-      },
-      "required": [
-        "id",
-        "name",
-        "capabilities"
-      ],
-      "type": "object"
-    },
-    "user": {
-      "additionalProperties": false,
-      "properties": {
-        "email": {
-          "description": "Email address of the user associated with the account.",
-          "type": "string"
-        },
-        "id": {
-          "description": "The user ID associated with the account. This is a UUID.",
-          "type": "integer",
-          "examples": [
-            "C95837C9-184B-4CC2-8779-B769F960FADB"
-          ]
-        }
-      },
-      "required": [
-        "id",
-        "email"
-      ],
-      "type": "object"
-    }
-  },
-  "type": "object",
-  "title": "me",
-  "x-readme-ref-name": "me"
-} as const;
-export default Me

package/test-utils/sdks/alby/src/schemas/NamespacePatch.ts

@@ -1,49 +0,0 @@
-const NamespacePatch = {
-  "additionalProperties": false,
-  "properties": {
-    "authenticated": {
-      "default": false,
-      "description": "If `true`, clients will not be permitted to use (including to attach, publish, or subscribe) any channels within this namespace unless they are identified, that is, authenticated using a client ID. See the <a href=\"https://knowledge.ably.com/authenticated-and-identified-clients\">Ably knowledge base/a> for more details.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "persistLast": {
-      "default": false,
-      "description": "If `true`, the last message published on a channel will be stored for 365 days. You can access the stored message only by using the channel rewind mechanism and attaching with rewind=1. Please note that for each message stored, an additional message is deducted from your monthly allocation.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "persisted": {
-      "default": false,
-      "description": "If `true`, all messages on a channel will be stored for 24 hours. You can access stored messages via the History API. Please note that for each message stored, an additional message is deducted from your monthly allocation.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "pushEnabled": {
-      "default": false,
-      "description": "If `true`, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "tlsOnly": {
-      "default": false,
-      "description": "If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    }
-  },
-  "type": "object",
-  "title": "namespace_patch",
-  "x-readme-ref-name": "namespace_patch"
-} as const;
-export default NamespacePatch

package/test-utils/sdks/alby/src/schemas/NamespacePost.ts

@@ -1,59 +0,0 @@
-const NamespacePost = {
-  "additionalProperties": false,
-  "properties": {
-    "authenticated": {
-      "default": false,
-      "description": "If `true`, clients will not be permitted to use (including to attach, publish, or subscribe) any channels within this namespace unless they are identified, that is, authenticated using a client ID. See the <a href=\"https://knowledge.ably.com/authenticated-and-identified-clients\">Ably Knowledge base</a> for more details.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "id": {
-      "description": "The namespace or channel name that the channel rule will apply to. For example, if you specify `namespace` the namespace will be set to `namespace` and will match with channels `namespace:*` and `namespace`.",
-      "type": "string",
-      "examples": [
-        "namespace"
-      ]
-    },
-    "persistLast": {
-      "default": false,
-      "description": "If `true`, the last message published on a channel will be stored for 365 days. You can access the stored message only by using the channel rewind mechanism and attaching with rewind=1. Please note that for each message stored, an additional message is deducted from your monthly allocation.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "persisted": {
-      "default": false,
-      "description": "If `true`, all messages on a channel will be stored for 24 hours. You can access stored messages via the History API. Please note that for each message stored, an additional message is deducted from your monthly allocation.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "pushEnabled": {
-      "default": false,
-      "description": "If `true`, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "tlsOnly": {
-      "default": false,
-      "description": "If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    }
-  },
-  "required": [
-    "id"
-  ],
-  "type": "object",
-  "title": "namespace_post",
-  "x-readme-ref-name": "namespace_post"
-} as const;
-export default NamespacePost

package/test-utils/sdks/alby/src/schemas/NamespaceResponse.ts

@@ -1,70 +0,0 @@
-const NamespaceResponse = {
-  "additionalProperties": false,
-  "properties": {
-    "authenticated": {
-      "default": false,
-      "description": "If `true`, clients will not be permitted to use (including to attach, publish, or subscribe) any channels within this namespace unless they are identified, that is, authenticated using a client ID. See the <a href=\"https://knowledge.ably.com/authenticated-and-identified-clients\">Ably knowledge base</a> for more details.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "created": {
-      "description": "Unix timestamp representing the date and time of creation of the namespace.",
-      "type": "integer",
-      "examples": [
-        1602844091815
-      ]
-    },
-    "id": {
-      "description": "The namespace or channel name that the channel rule will apply to. For example, if you specify `namespace` the namespace will be set to `namespace` and will match with channels `namespace:*` and `namespace`.",
-      "type": "string",
-      "examples": [
-        "namespace"
-      ]
-    },
-    "modified": {
-      "description": "Unix timestamp representing the date and time of last modification of the namespace.",
-      "type": "integer",
-      "examples": [
-        1614679682091
-      ]
-    },
-    "persistLast": {
-      "default": false,
-      "description": "If `true`, the last message published on a channel will be stored for 365 days. You can access the stored message only by using the channel rewind mechanism and attaching with rewind=1. Please note that for each message stored, an additional message is deducted from your monthly allocation.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "persisted": {
-      "default": false,
-      "description": "If `true`, all messages on a channel will be stored for 24 hours. You can access stored messages via the History API. Please note that for each message stored, an additional message is deducted from your monthly allocation.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "pushEnabled": {
-      "default": false,
-      "description": "If `true`, publishing messages with a push payload in the extras field is permitted and can trigger the delivery of a native push notification to registered devices for the channel.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    },
-    "tlsOnly": {
-      "default": false,
-      "description": "If `true`, only clients that are connected using TLS will be permitted to subscribe to any channels within this namespace.",
-      "type": "boolean",
-      "examples": [
-        false
-      ]
-    }
-  },
-  "type": "object",
-  "title": "namespace_response",
-  "x-readme-ref-name": "namespace_response"
-} as const;
-export default NamespaceResponse

package/test-utils/sdks/alby/src/schemas/PatchAppsAppIdKeysKeyId.ts

@@ -1,26 +0,0 @@
-const PatchAppsAppIdKeysKeyId = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "app_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The application ID."
-          },
-          "key_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The API key ID."
-          }
-        },
-        "required": [
-          "app_id",
-          "key_id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PatchAppsAppIdKeysKeyId

package/test-utils/sdks/alby/src/schemas/PatchAppsAppIdNamespacesNamespaceId.ts

@@ -1,26 +0,0 @@
-const PatchAppsAppIdNamespacesNamespaceId = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "app_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The application ID."
-          },
-          "namespace_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The namespace ID."
-          }
-        },
-        "required": [
-          "app_id",
-          "namespace_id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PatchAppsAppIdNamespacesNamespaceId

package/test-utils/sdks/alby/src/schemas/PatchAppsAppIdRulesRuleId.ts

@@ -1,26 +0,0 @@
-const PatchAppsAppIdRulesRuleId = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "app_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The application ID."
-          },
-          "rule_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The rule ID."
-          }
-        },
-        "required": [
-          "app_id",
-          "rule_id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PatchAppsAppIdRulesRuleId

package/test-utils/sdks/alby/src/schemas/PatchAppsId.ts

@@ -1,20 +0,0 @@
-const PatchAppsId = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The ID of application to be updated."
-          }
-        },
-        "required": [
-          "id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PatchAppsId

package/test-utils/sdks/alby/src/schemas/PostAccountsAccountIdApps.ts

@@ -1,20 +0,0 @@
-const PostAccountsAccountIdApps = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "account_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The account ID of the account in which to create the application."
-          }
-        },
-        "required": [
-          "account_id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PostAccountsAccountIdApps

package/test-utils/sdks/alby/src/schemas/PostAppsAppIdKeys.ts

@@ -1,20 +0,0 @@
-const PostAppsAppIdKeys = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "app_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The application ID."
-          }
-        },
-        "required": [
-          "app_id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PostAppsAppIdKeys

package/test-utils/sdks/alby/src/schemas/PostAppsAppIdKeysKeyIdRevoke.ts

@@ -1,26 +0,0 @@
-const PostAppsAppIdKeysKeyIdRevoke = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "app_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The application ID."
-          },
-          "key_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The key ID."
-          }
-        },
-        "required": [
-          "app_id",
-          "key_id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PostAppsAppIdKeysKeyIdRevoke

package/test-utils/sdks/alby/src/schemas/PostAppsAppIdNamespaces.ts

@@ -1,20 +0,0 @@
-const PostAppsAppIdNamespaces = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "app_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The application ID."
-          }
-        },
-        "required": [
-          "app_id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PostAppsAppIdNamespaces

package/test-utils/sdks/alby/src/schemas/PostAppsAppIdQueues.ts

@@ -1,20 +0,0 @@
-const PostAppsAppIdQueues = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "app_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The application ID."
-          }
-        },
-        "required": [
-          "app_id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PostAppsAppIdQueues

package/test-utils/sdks/alby/src/schemas/PostAppsAppIdRules.ts

@@ -1,20 +0,0 @@
-const PostAppsAppIdRules = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "app_id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The application ID."
-          }
-        },
-        "required": [
-          "app_id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PostAppsAppIdRules

package/test-utils/sdks/alby/src/schemas/PostAppsIdPkcs12.ts

@@ -1,20 +0,0 @@
-const PostAppsIdPkcs12 = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "id": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "The application ID."
-          }
-        },
-        "required": [
-          "id"
-        ]
-      }
-    ]
-  }
-} as const;
-export default PostAppsIdPkcs12

package/test-utils/sdks/alby/src/schemas/Queue.ts

@@ -1,43 +0,0 @@
-const Queue = {
-  "additionalProperties": false,
-  "properties": {
-    "maxLength": {
-      "description": "Message limit in number of messages.",
-      "type": "integer",
-      "examples": [
-        10000
-      ]
-    },
-    "name": {
-      "description": "A friendly name for your queue.",
-      "type": "string",
-      "examples": [
-        "My queue"
-      ]
-    },
-    "region": {
-      "description": "The data center region. US East (Virginia) or EU West (Ireland). Values are `us-east-1-a` or `eu-west-1-a`.",
-      "type": "string",
-      "examples": [
-        "us-east-1-a"
-      ]
-    },
-    "ttl": {
-      "description": "TTL in minutes.",
-      "type": "integer",
-      "examples": [
-        60
-      ]
-    }
-  },
-  "required": [
-    "name",
-    "ttl",
-    "maxLength",
-    "region"
-  ],
-  "type": "object",
-  "title": "queue",
-  "x-readme-ref-name": "queue"
-} as const;
-export default Queue