@bfra.me/api-core 0.1.0

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

@@ -0,0 +1,96 @@
+import RuleSource from './RuleSource.js';
+
+const AzureFunctionRulePatch = {
+  "additionalProperties": false,
+  "properties": {
+    "requestMode": {
+      "description": "This is Single Request mode or Batch Request mode. Single Request mode sends each event separately to the endpoint specified by the rule. Batch Request mode rolls up multiple events into the same request. You can read more about the difference between single and batched events in the Ably <a href=\"https://ably.com/documentation/general/events#batching\">documentation</a>.",
+      "enum": [
+        "single",
+        "batch"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case Microsoft Azure Function. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "http/azure-function"
+      ],
+      "type": "string"
+    },
+    "source": RuleSource,
+    "status": {
+      "description": "The status of the rule. Rules can be enabled or disabled.",
+      "enum": [
+        "enabled",
+        "disabled"
+      ],
+      "type": "string",
+      "examples": [
+        "enabled"
+      ]
+    },
+    "target": {
+      "additionalProperties": false,
+      "properties": {
+        "azureAppId": {
+          "description": "The Microsoft Azure Application ID. You can find your Microsoft Azure Application ID as shown in this <a href=\"https://dev.applicationinsights.io/documentation/Authorization/API-key-and-App-ID\">article</a>.",
+          "type": "string",
+          "examples": [
+            "d1e9f419-c438-6032b32df979"
+          ]
+        },
+        "azureFunctionName": {
+          "description": "The name of your Microsoft Azure Function.",
+          "type": "string"
+        },
+        "enveloped": {
+          "description": "Messages delivered through Reactor are wrapped in an Ably envelope by default that contains metadata about the message and its payload. The form of the envelope depends on whether it is part of a Webhook/Function or a Queue/Firehose rule. For everything besides Webhooks, you can ensure you only get the raw payload by unchecking \"Enveloped\" when setting up the rule.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "format": {
+          "description": "JSON provides a text-based encoding.",
+          "enum": [
+            "json"
+          ],
+          "type": "string"
+        },
+        "headers": {
+          "description": "If you have additional information to send, you'll need to include the relevant headers.",
+          "items": {
+            "properties": {
+              "name": {
+                "description": "The name of the header.",
+                "type": "string"
+              },
+              "value": {
+                "description": "The value of the header.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "signingKeyId": {
+          "description": "The signing key ID for use in `batch` mode. Ably will optionally sign the payload using an API key ensuring your servers can validate the payload using the private API key. See the <a href=\"https://ably.com/documentation/general/events#security\">webhook security docs</a> for more information.",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object",
+  "title": "azure_function_rule_patch",
+  "x-readme-ref-name": "azure_function_rule_patch"
+} as const;
+export default AzureFunctionRulePatch

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

@@ -0,0 +1,106 @@
+import RuleSource from './RuleSource.js';
+
+const AzureFunctionRulePost = {
+  "additionalProperties": false,
+  "properties": {
+    "requestMode": {
+      "description": "This is Single Request mode or Batch Request mode. Single Request mode sends each event separately to the endpoint specified by the rule. Batch Request mode rolls up multiple events into the same request. You can read more about the difference between single and batched events in the Ably <a href=\"https://ably.com/documentation/general/events#batching\">documentation</a>.",
+      "enum": [
+        "single",
+        "batch"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case Microsoft Azure Function. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "http/azure-function"
+      ],
+      "type": "string"
+    },
+    "source": RuleSource,
+    "status": {
+      "description": "The status of the rule. Rules can be enabled or disabled.",
+      "enum": [
+        "enabled",
+        "disabled"
+      ],
+      "type": "string",
+      "examples": [
+        "enabled"
+      ]
+    },
+    "target": {
+      "additionalProperties": false,
+      "properties": {
+        "azureAppId": {
+          "description": "The Microsoft Azure Application ID. You can find your Microsoft Azure Application ID as shown in this <a href=\"https://dev.applicationinsights.io/documentation/Authorization/API-key-and-App-ID\">article</a>.",
+          "type": "string",
+          "examples": [
+            "d1e9f419-c438-6032b32df979"
+          ]
+        },
+        "azureFunctionName": {
+          "description": "The name of your Microsoft Azure Function.",
+          "type": "string"
+        },
+        "enveloped": {
+          "description": "Messages delivered through Reactor are wrapped in an Ably envelope by default that contains metadata about the message and its payload. The form of the envelope depends on whether it is part of a Webhook/Function or a Queue/Firehose rule. For everything besides Webhooks, you can ensure you only get the raw payload by unchecking \"Enveloped\" when setting up the rule.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "format": {
+          "description": "JSON provides a text-based encoding.",
+          "enum": [
+            "json"
+          ],
+          "type": "string"
+        },
+        "headers": {
+          "description": "If you have additional information to send, you'll need to include the relevant headers.",
+          "items": {
+            "properties": {
+              "name": {
+                "description": "The name of the header.",
+                "type": "string"
+              },
+              "value": {
+                "description": "The value of the header.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "signingKeyId": {
+          "description": "The signing key ID for use in `batch` mode. Ably will optionally sign the payload using an API key ensuring your servers can validate the payload using the private API key. See the <a href=\"https://ably.com/documentation/general/events#security\">webhook security docs</a> for more information.",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "azureAppId",
+        "azureFunctionName"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "ruleType",
+    "requestMode",
+    "source",
+    "target"
+  ],
+  "type": "object",
+  "title": "azure_function_rule_post",
+  "x-readme-ref-name": "azure_function_rule_post"
+} as const;
+export default AzureFunctionRulePost

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

@@ -0,0 +1,145 @@
+import RuleSource from './RuleSource.js';
+
+const AzureFunctionRuleResponse = {
+  "additionalProperties": false,
+  "properties": {
+    "_links": {
+      "type": [
+        "object",
+        "null"
+      ],
+      "additionalProperties": true
+    },
+    "appId": {
+      "description": "The Ably application ID.",
+      "type": "string",
+      "examples": [
+        "28GY6a"
+      ]
+    },
+    "created": {
+      "description": "Unix timestamp representing the date and time of creation of the rule.",
+      "type": "number",
+      "examples": [
+        1602844091815
+      ]
+    },
+    "id": {
+      "description": "The rule ID.",
+      "type": "string",
+      "examples": [
+        "83IzAB"
+      ]
+    },
+    "modified": {
+      "description": "Unix timestamp representing the date and time of last modification of the rule.",
+      "type": "number",
+      "examples": [
+        1614679682091
+      ]
+    },
+    "requestMode": {
+      "description": "This is Single Request mode or Batch Request mode. Single Request mode sends each event separately to the endpoint specified by the rule. Batch Request mode rolls up multiple events into the same request. You can read more about the difference between single and batched events in the Ably <a href=\"https://ably.com/documentation/general/events#batching\">documentation</a>.\n\n`single` `batch`",
+      "enum": [
+        "single",
+        "batch"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case Microsoft Azure Function. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.\n\n`http/azure-function`",
+      "enum": [
+        "http/azure-function"
+      ],
+      "type": "string"
+    },
+    "source": RuleSource,
+    "status": {
+      "description": "The status of the rule. Rules can be enabled or disabled.\n\n`enabled` `disabled`",
+      "enum": [
+        "enabled",
+        "disabled"
+      ],
+      "type": "string",
+      "examples": [
+        "enabled"
+      ]
+    },
+    "target": {
+      "additionalProperties": false,
+      "properties": {
+        "azureAppId": {
+          "description": "The Microsoft Azure Application ID. You can find your Microsoft Azure Application ID as shown in this <a href=\"https://dev.applicationinsights.io/documentation/Authorization/API-key-and-App-ID\">article</a>.",
+          "type": "string",
+          "examples": [
+            "d1e9f419-c438-6032b32df979"
+          ]
+        },
+        "azureFunctionName": {
+          "description": "The name of your Microsoft Azure Function.",
+          "type": "string"
+        },
+        "enveloped": {
+          "description": "Messages delivered through Reactor are wrapped in an Ably envelope by default that contains metadata about the message and its payload. The form of the envelope depends on whether it is part of a Webhook/Function or a Queue/Firehose rule. For everything besides Webhooks, you can ensure you only get the raw payload by unchecking \"Enveloped\" when setting up the rule.",
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "format": {
+          "description": "JSON provides a text-based encoding.\n\n`json`",
+          "enum": [
+            "json"
+          ],
+          "type": "string"
+        },
+        "headers": {
+          "description": "If you have additional information to send, you'll need to include the relevant headers.",
+          "items": {
+            "properties": {
+              "name": {
+                "description": "The name of the header.",
+                "type": "string"
+              },
+              "value": {
+                "description": "The value of the header.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "signingKeyId": {
+          "description": "The signing key ID for use in `batch` mode. Ably will optionally sign the payload using an API key ensuring your servers can validate the payload using the private API key. See the <a href=\"https://ably.com/documentation/general/events#security\">webhook security docs</a> for more information.",
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "azureAppId",
+        "azureFunctionName"
+      ],
+      "type": "object"
+    },
+    "version": {
+      "description": "API version. Events and the format of their payloads are versioned. Please see the <a href=\"https://ably.com/documentation/general/events\">Events documentation</a>.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "ruleType",
+    "requestMode",
+    "source",
+    "target"
+  ],
+  "type": "object",
+  "title": "azure_function_rule_response",
+  "x-readme-ref-name": "azure_function_rule_response"
+} as const;
+export default AzureFunctionRuleResponse

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

@@ -0,0 +1,74 @@
+import RuleSource from './RuleSource.js';
+
+const CloudflareWorkerRulePatch = {
+  "additionalProperties": false,
+  "properties": {
+    "requestMode": {
+      "description": "This is Single Request mode or Batch Request mode. Single Request mode sends each event separately to the endpoint specified by the rule. Batch Request mode rolls up multiple events into the same request. You can read more about the difference between single and batched events in the Ably <a href=\"https://ably.com/documentation/general/events#batching\">documentation</a>.",
+      "enum": [
+        "single",
+        "batch"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case Cloudflare Worker. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "http/cloudflare-worker"
+      ],
+      "type": "string"
+    },
+    "source": RuleSource,
+    "status": {
+      "description": "The status of the rule. Rules can be enabled or disabled.",
+      "enum": [
+        "enabled",
+        "disabled"
+      ],
+      "type": "string",
+      "examples": [
+        "enabled"
+      ]
+    },
+    "target": {
+      "additionalProperties": false,
+      "properties": {
+        "headers": {
+          "description": "If you have additional information to send, you'll need to include the relevant headers.",
+          "items": {
+            "properties": {
+              "name": {
+                "description": "The name of the header.",
+                "type": "string"
+              },
+              "value": {
+                "description": "The value of the header.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "signingKeyId": {
+          "description": "The signing key ID for use in `batch` mode. Ably will optionally sign the payload using an API key ensuring your servers can validate the payload using the private API key. See the <a href=\"https://ably.com/documentation/general/events#security\">webhook security docs</a> for more information.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object",
+  "title": "cloudflare_worker_rule_patch",
+  "x-readme-ref-name": "cloudflare_worker_rule_patch"
+} as const;
+export default CloudflareWorkerRulePatch

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

@@ -0,0 +1,83 @@
+import RuleSource from './RuleSource.js';
+
+const CloudflareWorkerRulePost = {
+  "additionalProperties": false,
+  "properties": {
+    "requestMode": {
+      "description": "This is Single Request mode or Batch Request mode. Single Request mode sends each event separately to the endpoint specified by the rule. Batch Request mode rolls up multiple events into the same request. You can read more about the difference between single and batched events in the Ably <a href=\"https://ably.com/documentation/general/events#batching\">documentation</a>.",
+      "enum": [
+        "single",
+        "batch"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case Cloudflare Worker. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "http/cloudflare-worker"
+      ],
+      "type": "string"
+    },
+    "source": RuleSource,
+    "status": {
+      "description": "The status of the rule. Rules can be enabled or disabled.",
+      "enum": [
+        "enabled",
+        "disabled"
+      ],
+      "type": "string",
+      "examples": [
+        "enabled"
+      ]
+    },
+    "target": {
+      "additionalProperties": false,
+      "properties": {
+        "headers": {
+          "description": "If you have additional information to send, you'll need to include the relevant headers.",
+          "items": {
+            "properties": {
+              "name": {
+                "description": "The name of the header.",
+                "type": "string"
+              },
+              "value": {
+                "description": "The value of the header.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "signingKeyId": {
+          "description": "The signing key ID for use in `batch` mode. Ably will optionally sign the payload using an API key ensuring your servers can validate the payload using the private API key. See the <a href=\"https://ably.com/documentation/general/events#security\">webhook security docs</a> for more information.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "url"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "ruleType",
+    "requestMode",
+    "source",
+    "target"
+  ],
+  "type": "object",
+  "title": "cloudflare_worker_rule_post",
+  "x-readme-ref-name": "cloudflare_worker_rule_post"
+} as const;
+export default CloudflareWorkerRulePost

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

@@ -0,0 +1,125 @@
+import RuleSource from './RuleSource.js';
+
+const CloudflareWorkerRuleResponse = {
+  "additionalProperties": false,
+  "properties": {
+    "_links": {
+      "type": [
+        "object",
+        "null"
+      ],
+      "additionalProperties": true
+    },
+    "appId": {
+      "description": "The Ably application ID.",
+      "type": "string",
+      "examples": [
+        "28GY6a"
+      ]
+    },
+    "created": {
+      "description": "Unix timestamp representing the date and time of creation of the rule.",
+      "type": "number",
+      "examples": [
+        1602844091815
+      ]
+    },
+    "id": {
+      "description": "The rule ID.",
+      "type": "string",
+      "examples": [
+        "83IzAB"
+      ]
+    },
+    "modified": {
+      "description": "Unix timestamp representing the date and time of last modification of the rule.",
+      "type": "number",
+      "examples": [
+        1614679682091
+      ]
+    },
+    "requestMode": {
+      "description": "This is Single Request mode or Batch Request mode. Single Request mode sends each event separately to the endpoint specified by the rule. Batch Request mode rolls up multiple events into the same request. You can read more about the difference between single and batched events in the Ably <a href=\"https://ably.com/documentation/general/events#batching\">documentation</a>.\n\n`single` `batch`",
+      "enum": [
+        "single",
+        "batch"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case Cloudflare Worker. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.\n\n`http/cloudflare-worker`",
+      "enum": [
+        "http/cloudflare-worker"
+      ],
+      "type": "string",
+      "examples": [
+        "http/cloudflare-worker"
+      ]
+    },
+    "source": RuleSource,
+    "status": {
+      "description": "The status of the rule. Rules can be enabled or disabled.\n\n`enabled` `disabled`",
+      "enum": [
+        "enabled",
+        "disabled"
+      ],
+      "type": "string",
+      "examples": [
+        "enabled"
+      ]
+    },
+    "target": {
+      "additionalProperties": false,
+      "properties": {
+        "headers": {
+          "description": "If you have additional information to send, you'll need to include the relevant headers.",
+          "items": {
+            "properties": {
+              "name": {
+                "description": "The name of the header.",
+                "type": "string"
+              },
+              "value": {
+                "description": "The value of the header.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "signingKeyId": {
+          "description": "The signing key ID for use in `batch` mode. Ably will optionally sign the payload using an API key ensuring your servers can validate the payload using the private API key. See the <a href=\"https://ably.com/documentation/general/events#security\">webhook security docs</a> for more information.",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "url"
+      ],
+      "type": "object"
+    },
+    "version": {
+      "description": "API version. Events and the format of their payloads are versioned. Please see the <a href=\"https://ably.com/documentation/general/events\">Events documentation</a>.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "ruleType",
+    "requestMode",
+    "source",
+    "target"
+  ],
+  "type": "object",
+  "title": "cloudflare_worker_rule_response",
+  "x-readme-ref-name": "cloudflare_worker_rule_response"
+} as const;
+export default CloudflareWorkerRuleResponse

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

@@ -0,0 +1,26 @@
+const DeleteAppsAppIdNamespacesNamespaceId = {
+  "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 DeleteAppsAppIdNamespacesNamespaceId

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

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