@bfra.me/api-core 0.1.0 → 0.1.1

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

@@ -1,68 +0,0 @@
-const AppPatch = {
-  "additionalProperties": false,
-  "properties": {
-    "apnsCertificate": {
-      "description": "The Apple Push Notification service certificate.",
-      "type": [
-        "string",
-        "null"
-      ]
-    },
-    "apnsPrivateKey": {
-      "description": "The Apple Push Notification service private key.",
-      "type": [
-        "string",
-        "null"
-      ]
-    },
-    "apnsUseSandboxEndpoint": {
-      "description": "The Apple Push Notification service sandbox endpoint.",
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
-    "fcmKey": {
-      "description": "The Firebase Cloud Messaging key.",
-      "type": [
-        "string",
-        "null"
-      ],
-      "examples": [
-        false
-      ]
-    },
-    "name": {
-      "description": "The name of the application for your reference only.",
-      "type": "string",
-      "examples": [
-        "My App"
-      ]
-    },
-    "status": {
-      "description": "The status of the application. Can be `enabled` or `disabled`. Enabled means available to accept inbound connections and all services are available.",
-      "enum": [
-        "enabled",
-        "disabled"
-      ],
-      "type": "string",
-      "examples": [
-        "enabled"
-      ]
-    },
-    "tlsOnly": {
-      "description": "Enforce TLS for all connections.",
-      "type": [
-        "boolean",
-        "null"
-      ],
-      "examples": [
-        true
-      ]
-    }
-  },
-  "type": "object",
-  "title": "app_patch",
-  "x-readme-ref-name": "app_patch"
-} as const;
-export default AppPatch

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

@@ -1,22 +0,0 @@
-const AppPkcs12 = {
-  "additionalProperties": false,
-  "properties": {
-    "p12File": {
-      "description": "The `.p12` file containing the app's APNs information.",
-      "format": "binary",
-      "type": "string"
-    },
-    "p12Pass": {
-      "description": "The password for the corresponding `.p12` file.",
-      "type": "string"
-    }
-  },
-  "required": [
-    "p12File",
-    "p12Pass"
-  ],
-  "type": "object",
-  "title": "app_pkcs12",
-  "x-readme-ref-name": "app_pkcs12"
-} as const;
-export default AppPkcs12

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

@@ -1,71 +0,0 @@
-const AppPost = {
-  "additionalProperties": false,
-  "properties": {
-    "apnsCertificate": {
-      "description": "The Apple Push Notification service certificate.",
-      "type": [
-        "string",
-        "null"
-      ]
-    },
-    "apnsPrivateKey": {
-      "description": "The Apple Push Notification service private key.",
-      "type": [
-        "string",
-        "null"
-      ]
-    },
-    "apnsUseSandboxEndpoint": {
-      "description": "The Apple Push Notification service sandbox endpoint.",
-      "type": [
-        "boolean",
-        "null"
-      ]
-    },
-    "fcmKey": {
-      "description": "The Firebase Cloud Messaging key.",
-      "type": [
-        "string",
-        "null"
-      ],
-      "examples": [
-        false
-      ]
-    },
-    "name": {
-      "description": "The name of the application for your reference only.",
-      "type": "string",
-      "examples": [
-        "My App"
-      ]
-    },
-    "status": {
-      "description": "The status of the application. Can be `enabled` or `disabled`. Enabled means available to accept inbound connections and all services are available.",
-      "enum": [
-        "enabled",
-        "disabled"
-      ],
-      "type": "string",
-      "examples": [
-        "enabled"
-      ]
-    },
-    "tlsOnly": {
-      "description": "Enforce TLS for all connections.",
-      "type": [
-        "boolean",
-        "null"
-      ],
-      "examples": [
-        true
-      ]
-    }
-  },
-  "required": [
-    "name"
-  ],
-  "type": "object",
-  "title": "app_post",
-  "x-readme-ref-name": "app_post"
-} as const;
-export default AppPost

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

@@ -1,69 +0,0 @@
-const AppResponse = {
-  "additionalProperties": false,
-  "properties": {
-    "_links": {
-      "description": "A link self-referencing the app that has been created.",
-      "type": [
-        "object",
-        "null"
-      ],
-      "additionalProperties": true
-    },
-    "accountId": {
-      "description": "The ID of your Ably account.",
-      "type": "string",
-      "examples": [
-        "WgRpOB"
-      ]
-    },
-    "apnsUseSandboxEndpoint": {
-      "description": "Apple Push Notification service endpoint.",
-      "type": [
-        "boolean",
-        "null"
-      ],
-      "examples": [
-        false
-      ]
-    },
-    "id": {
-      "description": "The application ID.",
-      "type": "string",
-      "examples": [
-        "28AB6x"
-      ]
-    },
-    "name": {
-      "description": "The application name.",
-      "type": "string",
-      "examples": [
-        "Default"
-      ]
-    },
-    "status": {
-      "description": "The application status. Disabled applications will not accept new connections and will return an error to all clients.\n\n`enabled` `disabled`",
-      "enum": [
-        "enabled",
-        "disabled"
-      ],
-      "type": "string",
-      "examples": [
-        "enabled"
-      ]
-    },
-    "tlsOnly": {
-      "description": "Enforce TLS for all connections. This setting overrides any channel setting.",
-      "type": [
-        "boolean",
-        "null"
-      ],
-      "examples": [
-        true
-      ]
-    }
-  },
-  "type": "object",
-  "title": "app_response",
-  "x-readme-ref-name": "app_response"
-} as const;
-export default AppResponse

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

@@ -1,28 +0,0 @@
-const AwsAccessKeys = {
-  "additionalProperties": false,
-  "properties": {
-    "accessKeyId": {
-      "description": "The AWS key ID for the AWS IAM user. See this <a href=\"https://knowledge.ably.com/authentication-for-reactor-rules-for-aws-reactor-events-for-lambda-functions-reactor-firehose-for-aws-sqs-and-kinesis\">Ably knowledge base article</a> for details.",
-      "type": "string"
-    },
-    "authenticationMode": {
-      "description": "Authentication method is using AWS credentials (AWS key ID and secret key).",
-      "enum": [
-        "credentials"
-      ],
-      "type": "string"
-    },
-    "secretAccessKey": {
-      "description": "The AWS secret key for the AWS IAM user. See this <a href=\"https://knowledge.ably.com/authentication-for-reactor-rules-for-aws-reactor-events-for-lambda-functions-reactor-firehose-for-aws-sqs-and-kinesis\">Ably knowledge base article</a> for details.",
-      "type": "string"
-    }
-  },
-  "required": [
-    "accessKeyId",
-    "secretAccessKey"
-  ],
-  "type": "object",
-  "title": "aws_access_keys",
-  "x-readme-ref-name": "aws_access_keys"
-} as const;
-export default AwsAccessKeys

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

@@ -1,20 +0,0 @@
-const AwsAccessKeysResponse = {
-  "additionalProperties": false,
-  "properties": {
-    "accessKeyId": {
-      "description": "The AWS key ID for the AWS IAM user. See this <a href=\"https://knowledge.ably.com/authentication-for-reactor-rules-for-aws-reactor-events-for-lambda-functions-reactor-firehose-for-aws-sqs-and-kinesis\">Ably knowledge base article</a> for details.",
-      "type": "string"
-    },
-    "authenticationMode": {
-      "description": "Authentication method is using AWS credentials (AWS key ID and secret key).\n\n`credentials`",
-      "enum": [
-        "credentials"
-      ],
-      "type": "string"
-    }
-  },
-  "type": "object",
-  "title": "aws_access_keys_response",
-  "x-readme-ref-name": "aws_access_keys_response"
-} as const;
-export default AwsAccessKeysResponse

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

@@ -1,23 +0,0 @@
-const AwsAssumeRole = {
-  "additionalProperties": false,
-  "properties": {
-    "assumeRoleArn": {
-      "description": "If you are using the \"ARN of an assumable role\" authentication method, this is your Assume Role ARN. See this <a href=\"https://knowledge.ably.com/authentication-for-reactor-rules-for-aws-reactor-events-for-lambda-functions-reactor-firehose-for-aws-sqs-and-kinesis\">Ably knowledge base article</a> for details.",
-      "type": "string"
-    },
-    "authenticationMode": {
-      "description": "Authentication method is using the ARN of an assumable role. See this <a href=\"https://knowledge.ably.com/authentication-for-reactor-rules-for-aws-reactor-events-for-lambda-functions-reactor-firehose-for-aws-sqs-and-kinesis\">Ably knowledge base article</a> for details.\n\n`assumeRole`",
-      "enum": [
-        "assumeRole"
-      ],
-      "type": "string"
-    }
-  },
-  "required": [
-    "assumeRoleArn"
-  ],
-  "type": "object",
-  "title": "aws_assume_role",
-  "x-readme-ref-name": "aws_assume_role"
-} as const;
-export default AwsAssumeRole

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

@@ -1,90 +0,0 @@
-import AwsAccessKeys from './AwsAccessKeys.js';
-import AwsAssumeRole from './AwsAssumeRole.js';
-import RuleSource from './RuleSource.js';
-
-const AwsKinesisRulePatch = {
-  "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 AWS Kinesis. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
-      "enum": [
-        "aws/kinesis"
-      ],
-      "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": {
-        "authentication": {
-          "discriminator": {
-            "mapping": {
-              "assumeRole": "#/components/schemas/aws_assume_role",
-              "credentials": "#/components/schemas/aws_access_keys"
-            },
-            "propertyName": "authenticationMode"
-          },
-          "oneOf": [
-            AwsAccessKeys,
-            AwsAssumeRole
-          ]
-        },
-        "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"
-        },
-        "partitionKey": {
-          "description": "The AWS Kinesis partition 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"
-        },
-        "region": {
-          "description": "The region is which AWS Kinesis is hosted. See the <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#lambda_region\">AWS documentation</a> for more detail.",
-          "type": "string",
-          "examples": [
-            "us-west-1"
-          ]
-        },
-        "streamName": {
-          "description": "The name of your AWS Kinesis Stream.",
-          "type": "string"
-        }
-      },
-      "type": "object"
-    }
-  },
-  "type": "object",
-  "title": "aws_kinesis_rule_patch",
-  "x-readme-ref-name": "aws_kinesis_rule_patch"
-} as const;
-export default AwsKinesisRulePatch

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

@@ -1,103 +0,0 @@
-import AwsAccessKeys from './AwsAccessKeys.js';
-import AwsAssumeRole from './AwsAssumeRole.js';
-import RuleSource from './RuleSource.js';
-
-const AwsKinesisRulePost = {
-  "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 AWS Kinesis. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.",
-      "enum": [
-        "aws/kinesis"
-      ],
-      "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": {
-        "authentication": {
-          "discriminator": {
-            "mapping": {
-              "assumeRole": "#/components/schemas/aws_assume_role",
-              "credentials": "#/components/schemas/aws_access_keys"
-            },
-            "propertyName": "authenticationMode"
-          },
-          "oneOf": [
-            AwsAccessKeys,
-            AwsAssumeRole
-          ]
-        },
-        "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"
-        },
-        "partitionKey": {
-          "description": "The AWS Kinesis partition 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"
-        },
-        "region": {
-          "description": "The region is which AWS Kinesis is hosted. See the <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#lambda_region\">AWS documentation</a> for more detail.",
-          "type": "string",
-          "examples": [
-            "us-west-1"
-          ]
-        },
-        "streamName": {
-          "description": "The name of your AWS Kinesis Stream.",
-          "type": "string"
-        }
-      },
-      "required": [
-        "region",
-        "streamName",
-        "partitionKey",
-        "authentication",
-        "format"
-      ],
-      "type": "object"
-    }
-  },
-  "required": [
-    "ruleType",
-    "requestMode",
-    "source",
-    "target"
-  ],
-  "type": "object",
-  "title": "aws_kinesis_rule_post",
-  "x-readme-ref-name": "aws_kinesis_rule_post"
-} as const;
-export default AwsKinesisRulePost

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

@@ -1,142 +0,0 @@
-import AwsAccessKeysResponse from './AwsAccessKeysResponse.js';
-import AwsAssumeRole from './AwsAssumeRole.js';
-import RuleSource from './RuleSource.js';
-
-const AwsKinesisRuleResponse = {
-  "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 AWS Kinesis. See the <a href=\"https://ably.com/integrations\">documentation</a> for further information.\n\n`aws/kinesis`",
-      "enum": [
-        "aws/kinesis"
-      ],
-      "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": {
-        "authentication": {
-          "discriminator": {
-            "mapping": {
-              "assumeRole": "#/components/schemas/aws_assume_role",
-              "credentials": "#/components/schemas/aws_access_keys_response"
-            },
-            "propertyName": "authenticationMode"
-          },
-          "oneOf": [
-            AwsAccessKeysResponse,
-            AwsAssumeRole
-          ]
-        },
-        "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"
-        },
-        "partitionKey": {
-          "description": "The AWS Kinesis partition 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"
-        },
-        "region": {
-          "description": "The region is which AWS Kinesis is hosted. See the <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#lambda_region\">AWS documentation</a> for more detail.",
-          "type": "string",
-          "examples": [
-            "us-west-1"
-          ]
-        },
-        "streamName": {
-          "description": "The name of your AWS Kinesis Stream.",
-          "type": "string"
-        }
-      },
-      "required": [
-        "region",
-        "streamName",
-        "partitionKey",
-        "authentication",
-        "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": "aws_kinesis_rule_response",
-  "x-readme-ref-name": "aws_kinesis_rule_response"
-} as const;
-export default AwsKinesisRuleResponse