@bfra.me/api-core 0.1.0

package/test-utils/sdks/alby/src/index.ts

@@ -0,0 +1,18 @@
+import SDK from './sdk.js';
+
+/**
+ * Control API v1
+ *
+ * Use the Control API to manage your applications, namespaces, keys, queues, rules, and
+ * more.
+ *
+ * Detailed information on using this API can be found in the Ably <a
+ * href="https://ably.com/documentation/control-api">developer documentation</a>.
+ *
+ * Control API is currently in Beta.
+ *
+ *
+ */
+const createSDK = (() => { return new SDK(); })();
+
+export default createSDK;

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

@@ -0,0 +1,92 @@
+import RuleSource from './RuleSource.js';
+
+const AmqpExternalRulePatch = {
+  "additionalProperties": false,
+  "properties": {
+    "requestMode": {
+      "description": "Single request mode sends each event separately to the endpoint specified by the rule. You can read more about single request mode events in the <a href=\"https://ably.com/documentation/general/events#batching\">Ably documentation</a>.",
+      "enum": [
+        "single"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case AMQP external (using Firehose). See the <a href=\"https://ably.com/documentation/general/firehose\">Ably documentation</a> for further information.",
+      "enum": [
+        "amqp/external"
+      ],
+      "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": {
+        "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": {
+          "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"
+        },
+        "mandatoryRoute": {
+          "description": "Reject delivery of the message if the route does not exist, otherwise fail silently.",
+          "type": "boolean"
+        },
+        "messageTtl": {
+          "description": "You can optionally override the default TTL on a queue and specify a TTL in minutes for messages to be persisted. It is unusual to change the default TTL, so if this field is left empty, the default TTL for the queue will be used.",
+          "type": "integer"
+        },
+        "persistentMessages": {
+          "description": "Marks the message as persistent, instructing the broker to write it to disk if it is in a durable queue.",
+          "type": "boolean"
+        },
+        "routingKey": {
+          "description": "The AMQP routing key. See this <a href=\"https://knowledge.ably.com/what-is-the-format-of-the-routingkey-for-an-amqp-or-kinesis-reactor-rule\">Ably knowledge base article</a> for details.",
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object",
+  "title": "amqp_external_rule_patch",
+  "x-readme-ref-name": "amqp_external_rule_patch"
+} as const;
+export default AmqpExternalRulePatch

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

@@ -0,0 +1,93 @@
+import RuleSource from './RuleSource.js';
+
+const AmqpExternalRulePost = {
+  "additionalProperties": false,
+  "properties": {
+    "requestMode": {
+      "description": "Single request mode sends each event separately to the endpoint specified by the rule. You can read more about single request mode events in the <a href=\"https://ably.com/documentation/general/events#batching\">Ably documentation</a>.",
+      "enum": [
+        "single"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case AMQP external (using Firehose). See the <a href=\"https://ably.com/documentation/general/firehose\">documentation</a> for further information.",
+      "enum": [
+        "amqp/external"
+      ],
+      "type": "string"
+    },
+    "source": RuleSource,
+    "target": {
+      "additionalProperties": false,
+      "properties": {
+        "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": {
+          "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"
+        },
+        "mandatoryRoute": {
+          "description": "Reject delivery of the message if the route does not exist, otherwise fail silently.",
+          "type": "boolean"
+        },
+        "messageTtl": {
+          "description": "You can optionally override the default TTL on a queue and specify a TTL in minutes for messages to be persisted. It is unusual to change the default TTL, so if this field is left empty, the default TTL for the queue will be used.",
+          "type": "integer"
+        },
+        "persistentMessages": {
+          "description": "Marks the message as persistent, instructing the broker to write it to disk if it is in a durable queue.",
+          "type": "boolean"
+        },
+        "routingKey": {
+          "description": "The AMQP routing key. See this <a href=\"https://knowledge.ably.com/what-is-the-format-of-the-routingkey-for-an-amqp-or-kinesis-reactor-rule\">Ably knowledge base article</a> for details.",
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "url",
+        "routingKey",
+        "mandatoryRoute",
+        "persistentMessages"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "ruleType",
+    "requestMode",
+    "source",
+    "target"
+  ],
+  "type": "object",
+  "title": "amqp_external_rule_post",
+  "x-readme-ref-name": "amqp_external_rule_post"
+} as const;
+export default AmqpExternalRulePost

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

@@ -0,0 +1,143 @@
+import RuleSource from './RuleSource.js';
+
+const AmqpExternalRuleResponse = {
+  "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": "Single request mode sends each event separately to the endpoint specified by the rule. You can read more about single request mode events in the <a href=\"https://ably.com/documentation/general/events#batching\">Ably documentation</a>.\n\n`single`",
+      "enum": [
+        "single"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case AMQP external (using Firehose). See the <a href=\"https://ably.com/documentation/general/firehose\">Ably documentation</a> for further information.\n\n`amqp/external`",
+      "enum": [
+        "amqp/external"
+      ],
+      "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": {
+        "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": {
+          "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"
+        },
+        "mandatoryRoute": {
+          "description": "Reject delivery of the message if the route does not exist, otherwise fail silently.",
+          "type": "boolean"
+        },
+        "messageTtl": {
+          "description": "You can optionally override the default TTL on a queue and specify a TTL in minutes for messages to be persisted. It is unusual to change the default TTL, so if this field is left empty, the default TTL for the queue will be used.",
+          "type": "integer"
+        },
+        "persistentMessages": {
+          "description": "Marks the message as persistent, instructing the broker to write it to disk if it is in a durable queue.",
+          "type": "boolean"
+        },
+        "routingKey": {
+          "description": "The AMQP routing key. See this <a href=\"https://knowledge.ably.com/what-is-the-format-of-the-routingkey-for-an-amqp-or-kinesis-reactor-rule\">Ably knowledge base article</a> for details.",
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "url",
+        "routingKey",
+        "mandatoryRoute",
+        "persistentMessages"
+      ],
+      "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": "amqp_external_rule_response",
+  "x-readme-ref-name": "amqp_external_rule_response"
+} as const;
+export default AmqpExternalRuleResponse

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

@@ -0,0 +1,76 @@
+import RuleSource from './RuleSource.js';
+
+const AmqpRulePatch = {
+  "additionalProperties": false,
+  "properties": {
+    "requestMode": {
+      "description": "Single request mode sends each event separately to the endpoint specified by the rule. You can read more about single request mode events in the <a href=\"https://ably.com/documentation/general/events#batching\">Ably documentation</a>.",
+      "enum": [
+        "single"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case AMQP. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "amqp"
+      ],
+      "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": {
+        "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": {
+          "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"
+        },
+        "queueId": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object",
+  "title": "amqp_rule_patch",
+  "x-readme-ref-name": "amqp_rule_patch"
+} as const;
+export default AmqpRulePatch

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

@@ -0,0 +1,85 @@
+import RuleSource from './RuleSource.js';
+
+const AmqpRulePost = {
+  "additionalProperties": false,
+  "properties": {
+    "requestMode": {
+      "description": "Single request mode sends each event separately to the endpoint specified by the rule. You can read more about single request mode events in the <a href=\"https://ably.com/documentation/general/events#batching\">Ably documentation</a>.",
+      "enum": [
+        "single"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case AMQP. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "amqp"
+      ],
+      "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": {
+        "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": {
+          "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"
+        },
+        "queueId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "queueId"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "ruleType",
+    "requestMode",
+    "source",
+    "target"
+  ],
+  "type": "object",
+  "title": "amqp_rule_post",
+  "x-readme-ref-name": "amqp_rule_post"
+} as const;
+export default AmqpRulePost

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

@@ -0,0 +1,124 @@
+import RuleSource from './RuleSource.js';
+
+const AmqpRuleResponse = {
+  "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": "Single request mode sends each event separately to the endpoint specified by the rule. You can read more about single request mode events in the <a href=\"https://ably.com/documentation/general/events#batching\">Ably documentation</a>.\n\n`single`",
+      "enum": [
+        "single"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "The type of rule. In this case AMQP. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.\n\n`amqp`",
+      "enum": [
+        "amqp"
+      ],
+      "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": {
+        "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": {
+          "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"
+        },
+        "queueId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "queueId"
+      ],
+      "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": "amqp_rule_response",
+  "x-readme-ref-name": "amqp_rule_response"
+} as const;
+export default AmqpRuleResponse