@bfra.me/api-core 0.1.0

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

@@ -0,0 +1,185 @@
+const QueueResponse = {
+  "additionalProperties": false,
+  "properties": {
+    "amqp": {
+      "additionalProperties": false,
+      "properties": {
+        "queueName": {
+          "description": "Name of the Ably queue.",
+          "type": "string",
+          "examples": [
+            "28AB6w:My queue"
+          ]
+        },
+        "uri": {
+          "description": "URI for the AMQP queue interface.",
+          "type": "string",
+          "examples": [
+            "amqps://us-east-1-a-queue.ably.io:5671/shared"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "appId": {
+      "description": "The Ably application ID.",
+      "type": "string",
+      "examples": [
+        "28AB6w"
+      ]
+    },
+    "deadletter": {
+      "description": "A boolean that indicates whether this is a dead letter queue or not.",
+      "type": "boolean",
+      "examples": [
+        false
+      ]
+    },
+    "deadletterId": {
+      "type": [
+        "string",
+        "null"
+      ],
+      "examples": [
+        "28AB6w:us-east-1-a:deadletter"
+      ]
+    },
+    "id": {
+      "description": "The ID of the Ably queue",
+      "type": "string",
+      "examples": [
+        "28AB6w:us-east-1-a:My queue"
+      ]
+    },
+    "maxLength": {
+      "description": "Message limit in number of messages.",
+      "type": "integer",
+      "examples": [
+        10000
+      ]
+    },
+    "messages": {
+      "additionalProperties": false,
+      "description": "Details of messages in the queue.",
+      "properties": {
+        "ready": {
+          "description": "The number of ready messages in the queue.",
+          "type": [
+            "integer",
+            "null"
+          ],
+          "examples": [
+            0
+          ]
+        },
+        "total": {
+          "description": "The total number of messages in the queue.",
+          "type": [
+            "integer",
+            "null"
+          ],
+          "examples": [
+            0
+          ]
+        },
+        "unacknowledged": {
+          "description": "The number of unacknowledged messages in the queue.",
+          "type": [
+            "integer",
+            "null"
+          ],
+          "examples": [
+            0
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "name": {
+      "description": "The friendly name of the queue.",
+      "type": "string",
+      "examples": [
+        "My queue"
+      ]
+    },
+    "region": {
+      "description": "The data center region for the queue.",
+      "type": "string",
+      "examples": [
+        "eu-west-1-a"
+      ]
+    },
+    "state": {
+      "description": "The current state of the queue.",
+      "type": "string",
+      "examples": [
+        "Running"
+      ]
+    },
+    "stats": {
+      "additionalProperties": false,
+      "properties": {
+        "acknowledgementRate": {
+          "description": "The rate at which messages are acknowledged. Rate is messages per minute.",
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "deliveryRate": {
+          "description": "The rate at which messages are delivered from the queue. Rate is messages per minute.",
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "publishRate": {
+          "description": "The rate at which messages are published to the queue. Rate is messages per minute.",
+          "type": [
+            "number",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "stomp": {
+      "additionalProperties": false,
+      "properties": {
+        "destination": {
+          "description": "Destination queue.",
+          "type": "string",
+          "examples": [
+            "/amqp/queue/28AB6w:My queue"
+          ]
+        },
+        "host": {
+          "description": "The host type for the queue.",
+          "type": "string",
+          "examples": [
+            "shared"
+          ]
+        },
+        "uri": {
+          "description": "URI for the STOMP queue interface.",
+          "type": "string",
+          "examples": [
+            "stomp://us-east-1-a-queue.ably.io:61614"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "ttl": {
+      "description": "TTL in minutes.",
+      "type": "integer",
+      "examples": [
+        60
+      ]
+    }
+  },
+  "type": "object",
+  "title": "queue_response",
+  "x-readme-ref-name": "queue_response"
+} as const;
+export default QueueResponse

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

@@ -0,0 +1,46 @@
+import AmqpExternalRulePatch from './AmqpExternalRulePatch.js';
+import AmqpRulePatch from './AmqpRulePatch.js';
+import AwsKinesisRulePatch from './AwsKinesisRulePatch.js';
+import AwsLambdaRulePatch from './AwsLambdaRulePatch.js';
+import AwsSqsRulePatch from './AwsSqsRulePatch.js';
+import AzureFunctionRulePatch from './AzureFunctionRulePatch.js';
+import CloudflareWorkerRulePatch from './CloudflareWorkerRulePatch.js';
+import GoogleCloudFunctionRulePatch from './GoogleCloudFunctionRulePatch.js';
+import HttpRulePatch from './HttpRulePatch.js';
+import IftttRulePatch from './IftttRulePatch.js';
+import ZapierRulePatch from './ZapierRulePatch.js';
+
+const RulePatch = {
+  "discriminator": {
+    "mapping": {
+      "amqp": "#/components/schemas/amqp_rule_patch",
+      "amqp/external": "#/components/schemas/amqp_external_rule_patch",
+      "aws/kinesis": "#/components/schemas/aws_kinesis_rule_patch",
+      "aws/lambda": "#/components/schemas/aws_lambda_rule_patch",
+      "aws/sqs": "#/components/schemas/aws_sqs_rule_patch",
+      "http": "#/components/schemas/http_rule_patch",
+      "http/azure-function": "#/components/schemas/azure_function_rule_patch",
+      "http/cloudflare-worker": "#/components/schemas/cloudflare_worker_rule_patch",
+      "http/google-cloud-function": "#/components/schemas/google_cloud_function_rule_patch",
+      "http/ifttt": "#/components/schemas/ifttt_rule_patch",
+      "http/zapier": "#/components/schemas/zapier_rule_patch"
+    },
+    "propertyName": "ruleType"
+  },
+  "oneOf": [
+    HttpRulePatch,
+    IftttRulePatch,
+    ZapierRulePatch,
+    CloudflareWorkerRulePatch,
+    AzureFunctionRulePatch,
+    GoogleCloudFunctionRulePatch,
+    AwsLambdaRulePatch,
+    AwsKinesisRulePatch,
+    AwsSqsRulePatch,
+    AmqpRulePatch,
+    AmqpExternalRulePatch
+  ],
+  "title": "rule_patch",
+  "x-readme-ref-name": "rule_patch"
+} as const;
+export default RulePatch

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

@@ -0,0 +1,49 @@
+import AmqpExternalRulePost from './AmqpExternalRulePost.js';
+import AmqpRulePost from './AmqpRulePost.js';
+import AwsKinesisRulePost from './AwsKinesisRulePost.js';
+import AwsLambdaRulePost from './AwsLambdaRulePost.js';
+import AwsSqsRulePost from './AwsSqsRulePost.js';
+import AzureFunctionRulePost from './AzureFunctionRulePost.js';
+import CloudflareWorkerRulePost from './CloudflareWorkerRulePost.js';
+import GoogleCloudFunctionRulePost from './GoogleCloudFunctionRulePost.js';
+import HttpRulePost from './HttpRulePost.js';
+import IftttRulePost from './IftttRulePost.js';
+import UnsupportedRuleResponse from './UnsupportedRuleResponse.js';
+import ZapierRulePost from './ZapierRulePost.js';
+
+const RulePost = {
+  "discriminator": {
+    "mapping": {
+      "amqp": "#/components/schemas/amqp_rule_post",
+      "amqp/external": "#/components/schemas/amqp_external_rule_post",
+      "aws/kinesis": "#/components/schemas/aws_kinesis_rule_post",
+      "aws/lambda": "#/components/schemas/aws_lambda_rule_post",
+      "aws/sqs": "#/components/schemas/aws_sqs_rule_post",
+      "http": "#/components/schemas/http_rule_post",
+      "http/azure-function": "#/components/schemas/azure_function_rule_post",
+      "http/cloudflare-worker": "#/components/schemas/cloudflare_worker_rule_post",
+      "http/google-cloud-function": "#/components/schemas/google_cloud_function_rule_post",
+      "http/ifttt": "#/components/schemas/ifttt_rule_post",
+      "http/zapier": "#/components/schemas/zapier_rule_post",
+      "unsupported": "#/components/schemas/unsupported_rule_response"
+    },
+    "propertyName": "ruleType"
+  },
+  "oneOf": [
+    HttpRulePost,
+    IftttRulePost,
+    ZapierRulePost,
+    CloudflareWorkerRulePost,
+    AzureFunctionRulePost,
+    GoogleCloudFunctionRulePost,
+    AwsLambdaRulePost,
+    AwsKinesisRulePost,
+    AwsSqsRulePost,
+    AmqpRulePost,
+    AmqpExternalRulePost,
+    UnsupportedRuleResponse
+  ],
+  "title": "rule_post",
+  "x-readme-ref-name": "rule_post"
+} as const;
+export default RulePost

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

@@ -0,0 +1,46 @@
+import AmqpExternalRuleResponse from './AmqpExternalRuleResponse.js';
+import AmqpRuleResponse from './AmqpRuleResponse.js';
+import AwsKinesisRuleResponse from './AwsKinesisRuleResponse.js';
+import AwsLambdaRuleResponse from './AwsLambdaRuleResponse.js';
+import AwsSqsRuleResponse from './AwsSqsRuleResponse.js';
+import AzureFunctionRuleResponse from './AzureFunctionRuleResponse.js';
+import CloudflareWorkerRuleResponse from './CloudflareWorkerRuleResponse.js';
+import GoogleCloudFunctionRuleResponse from './GoogleCloudFunctionRuleResponse.js';
+import HttpRuleResponse from './HttpRuleResponse.js';
+import IftttRuleResponse from './IftttRuleResponse.js';
+import ZapierRuleResponse from './ZapierRuleResponse.js';
+
+const RuleResponse = {
+  "discriminator": {
+    "mapping": {
+      "amqp": "#/components/schemas/amqp_rule_response",
+      "amqp/external": "#/components/schemas/amqp_external_rule_response",
+      "aws/kinesis": "#/components/schemas/aws_kinesis_rule_response",
+      "aws/lambda": "#/components/schemas/aws_lambda_rule_response",
+      "aws/sqs": "#/components/schemas/aws_sqs_rule_response",
+      "http": "#/components/schemas/http_rule_response",
+      "http/azure-function": "#/components/schemas/azure_function_rule_response",
+      "http/cloudflare-worker": "#/components/schemas/cloudflare_worker_rule_response",
+      "http/google-cloud-function": "#/components/schemas/google_cloud_function_rule_response",
+      "http/ifttt": "#/components/schemas/ifttt_rule_response",
+      "http/zapier": "#/components/schemas/zapier_rule_response"
+    },
+    "propertyName": "ruleType"
+  },
+  "oneOf": [
+    HttpRuleResponse,
+    IftttRuleResponse,
+    ZapierRuleResponse,
+    CloudflareWorkerRuleResponse,
+    AzureFunctionRuleResponse,
+    GoogleCloudFunctionRuleResponse,
+    AwsLambdaRuleResponse,
+    AwsKinesisRuleResponse,
+    AwsSqsRuleResponse,
+    AmqpRuleResponse,
+    AmqpExternalRuleResponse
+  ],
+  "title": "rule_response",
+  "x-readme-ref-name": "rule_response"
+} as const;
+export default RuleResponse

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

@@ -0,0 +1,30 @@
+const RuleSource = {
+  "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.\n\n`channel.message` `channel.presence` `channel.lifecycle` `channel.occupancy`",
+      "enum": [
+        "channel.message",
+        "channel.presence",
+        "channel.lifecycle",
+        "channel.occupancy"
+      ],
+      "type": "string",
+      "examples": [
+        "channel.message"
+      ]
+    }
+  },
+  "required": [
+    "channelFilter",
+    "type"
+  ],
+  "type": "object",
+  "title": "rule_source",
+  "x-readme-ref-name": "rule_source"
+} as const;
+export default RuleSource

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

@@ -0,0 +1,98 @@
+import RuleSource from './RuleSource.js';
+
+const UnsupportedRuleResponse = {
+  "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>.",
+      "enum": [
+        "single",
+        "batch"
+      ],
+      "type": "string",
+      "examples": [
+        "single"
+      ]
+    },
+    "ruleType": {
+      "description": "This rule type is currently unsupported.",
+      "enum": [
+        "unsupported"
+      ],
+      "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": {
+        "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": "unsupported_rule_response",
+  "x-readme-ref-name": "unsupported_rule_response"
+} as const;
+export default UnsupportedRuleResponse

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

@@ -0,0 +1,74 @@
+import RuleSource from './RuleSource.js';
+
+const ZapierRulePatch = {
+  "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 Zapier. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "http/zapier"
+      ],
+      "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": "zapier_rule_patch",
+  "x-readme-ref-name": "zapier_rule_patch"
+} as const;
+export default ZapierRulePatch

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

@@ -0,0 +1,83 @@
+import RuleSource from './RuleSource.js';
+
+const ZapierRulePost = {
+  "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 Zapier. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
+      "enum": [
+        "http/zapier"
+      ],
+      "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": "zapier_rule_post",
+  "x-readme-ref-name": "zapier_rule_post"
+} as const;
+export default ZapierRulePost