@bfra.me/api-core 0.1.0

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

@@ -0,0 +1,89 @@
+import RuleSource from './RuleSource.js';
+
+const HttpRulePatch = {
+  "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. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "http"
+      ],
+      "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": {
+          "description": "JSON provides a simpler text-based encoding, whereas MsgPack provides a more efficient binary encoding.",
+          "enum": [
+            "json",
+            "msgpack"
+          ],
+          "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"
+          ]
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object",
+  "title": "http_rule_patch",
+  "x-readme-ref-name": "http_rule_patch"
+} as const;
+export default HttpRulePatch

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

@@ -0,0 +1,100 @@
+import RuleSource from './RuleSource.js';
+
+const HttpRulePost = {
+  "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. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "http"
+      ],
+      "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": {
+          "description": "JSON provides a simpler text-based encoding, whereas MsgPack provides a more efficient binary encoding.",
+          "enum": [
+            "json",
+            "msgpack"
+          ],
+          "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"
+          ]
+        },
+        "url": {
+          "description": "The URL of the endpoint that is invoked when events occur on Ably.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "url",
+        "format"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "ruleType",
+    "requestMode",
+    "source",
+    "target"
+  ],
+  "type": "object",
+  "title": "http_rule_post",
+  "x-readme-ref-name": "http_rule_post"
+} as const;
+export default HttpRulePost

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

@@ -0,0 +1,138 @@
+import RuleSource from './RuleSource.js';
+
+const HttpRuleResponse = {
+  "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. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.\n\n`http`",
+      "enum": [
+        "http"
+      ],
+      "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": {
+          "description": "JSON provides a simpler text-based encoding, whereas MsgPack provides a more efficient binary encoding.\n\n`json` `msgpack`",
+          "enum": [
+            "json",
+            "msgpack"
+          ],
+          "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"
+          ]
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "url",
+        "format"
+      ],
+      "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": "http_rule_response",
+  "x-readme-ref-name": "http_rule_response"
+} as const;
+export default HttpRuleResponse

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

@@ -0,0 +1,59 @@
+const IftttRulePatch = {
+  "x-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"
+    ],
+    "example": "single",
+    "type": "string"
+  },
+  "x-ruleType": {
+    "description": "The type of rule. In this case IFTTT. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+    "enum": [
+      "http/ifttt"
+    ],
+    "type": "string"
+  },
+  "x-source": {
+    "additionalProperties": false,
+    "properties": {
+      "channelFilter": {
+        "description": "This field allows you to filter your rule based on a regular expression that is matched against the complete channel name. Leave this empty if you want the rule to apply to all channels.",
+        "type": "string"
+      },
+      "type": {
+        "description": "The type `channel.message` delivers all messages published on a channel. The type `channel.presence` delivers all enter, update and leave events for members present on a channel. The type `channel.lifecycle` events for this rule type are currently not supported. Get in touch (https://ably.com/contact) if you need this feature. The type `channel.occupancy` delivers all occupancy events for the channel.",
+        "enum": [
+          "channel.message",
+          "channel.presence",
+          "channel.lifecycle",
+          "channel.occupancy"
+        ],
+        "example": "channel.message",
+        "type": "string"
+      }
+    },
+    "required": [
+      "channelFilter",
+      "type"
+    ],
+    "type": "object",
+    "title": "rule_source",
+    "x-readme-ref-name": "rule_source"
+  },
+  "x-target": {
+    "additionalProperties": false,
+    "properties": {
+      "eventName": {
+        "type": "string"
+      },
+      "webhookKey": {
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  "title": "ifttt_rule_patch",
+  "x-readme-ref-name": "ifttt_rule_patch"
+} as const;
+export default IftttRulePatch

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

@@ -0,0 +1,62 @@
+import RuleSource from './RuleSource.js';
+
+const IftttRulePost = {
+  "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 IFTTT. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "http/ifttt"
+      ],
+      "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": {
+        "eventName": {
+          "type": "string"
+        },
+        "webhookKey": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "webhookKey",
+        "eventName"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "ruleType",
+    "requestMode",
+    "source",
+    "target"
+  ],
+  "type": "object",
+  "title": "ifttt_rule_post",
+  "x-readme-ref-name": "ifttt_rule_post"
+} as const;
+export default IftttRulePost

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

@@ -0,0 +1,101 @@
+import RuleSource from './RuleSource.js';
+
+const IftttRuleResponse = {
+  "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 IFTTT. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.\n\n`http/ifttt`",
+      "enum": [
+        "http/ifttt"
+      ],
+      "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": {
+        "eventName": {
+          "type": "string"
+        },
+        "webhookKey": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "webhookKey",
+        "eventName"
+      ],
+      "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": "ifttt_rule_response",
+  "x-readme-ref-name": "ifttt_rule_response"
+} as const;
+export default IftttRuleResponse

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

@@ -0,0 +1,34 @@
+const KeyPatch = {
+  "additionalProperties": false,
+  "properties": {
+    "capabilities": {
+      "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>.",
+      "items": {
+        "enum": [
+          "publish",
+          "subscribe",
+          "history",
+          "presence",
+          "channel-metadata",
+          "push-admin",
+          "push-subscribe",
+          "statistics"
+        ],
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "channels": {
+      "description": "Specify the channels and queues that this key can be used with.",
+      "type": "string"
+    },
+    "name": {
+      "description": "The name for your API key. This is a friendly name for your reference.",
+      "type": "string"
+    }
+  },
+  "type": "object",
+  "title": "key_patch",
+  "x-readme-ref-name": "key_patch"
+} as const;
+export default KeyPatch

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

@@ -0,0 +1,39 @@
+const KeyPost = {
+  "additionalProperties": false,
+  "properties": {
+    "capabilities": {
+      "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>.",
+      "items": {
+        "enum": [
+          "publish",
+          "subscribe",
+          "history",
+          "presence",
+          "channel-metadata",
+          "push-admin",
+          "push-subscribe",
+          "statistics"
+        ],
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "channels": {
+      "description": "Specify the channels and queues that this key can be used with.",
+      "type": "string"
+    },
+    "name": {
+      "description": "The name for your API key. This is a friendly name for your reference.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "name",
+    "channels",
+    "capabilities"
+  ],
+  "type": "object",
+  "title": "key_post",
+  "x-readme-ref-name": "key_post"
+} as const;
+export default KeyPost