samva 0.16.0 → 0.18.0

package/dist/effect/generated/unsubscribe-groups.js

@@ -0,0 +1,267 @@
+import { ApiKeySecurityMiddleware, ConflictError, Cursor, ForbiddenError, GatewayTimeoutError, InternalError, ResourceNotFoundError, UnauthorizedError, UnsubscribeId, ValidationError } from "./shared.js";
+import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/http-api";
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/unsubscribe-groups.ts
+const UnsubscribeGroupMemberPage = /* @__PURE__ */ Schema.Struct({
+	items: Schema.Array(Schema.Struct({
+		id: Schema.String,
+		email: Schema.String,
+		contactId: Schema.Union([Schema.String, Schema.Null]),
+		source: Schema.Union([
+			Schema.Literal("link"),
+			Schema.Literal("api"),
+			Schema.Literal("manual"),
+			Schema.Literal("complaint")
+		]),
+		unsubscribedAt: Schema.String,
+		createdAt: Schema.String
+	})),
+	nextCursor: Schema.Union([Schema.String, Schema.Null])
+}).annotate({ identifier: "UnsubscribeGroupMemberPage" });
+const UnsubscribeGroupList = /* @__PURE__ */ Schema.Struct({ items: Schema.Array(Schema.Struct({
+	id: UnsubscribeId,
+	organizationId: Schema.String,
+	name: Schema.String,
+	description: Schema.Union([Schema.String, Schema.Null]),
+	isDefault: Schema.Boolean,
+	memberCount: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	createdAt: Schema.String,
+	updatedAt: Schema.String
+})).check(Schema.isMaxLength(200).annotate({ expected: "a value with a length of at most 200" })) }).annotate({ identifier: "UnsubscribeGroupList" });
+const UnsubscribeList200 = UnsubscribeGroupList;
+const UnsubscribeList401 = UnauthorizedError;
+const UnsubscribeList403 = ForbiddenError;
+const UnsubscribeList422 = ValidationError;
+const UnsubscribeList500 = InternalError;
+const UnsubscribeList504 = GatewayTimeoutError;
+const UnsubscribeCreateRequestJson = /* @__PURE__ */ Schema.Struct({
+	name: Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })),
+	description: Schema.optionalKey(Schema.Union([Schema.Union([Schema.String, Schema.Null]), Schema.Null]))
+});
+const UnsubscribeCreate201 = /* @__PURE__ */ Schema.Struct({
+	id: UnsubscribeId,
+	organizationId: Schema.String,
+	name: Schema.String,
+	description: Schema.Union([Schema.String, Schema.Null]),
+	isDefault: Schema.Boolean,
+	memberCount: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	createdAt: Schema.String,
+	updatedAt: Schema.String
+});
+const UnsubscribeCreate401 = UnauthorizedError;
+const UnsubscribeCreate403 = ForbiddenError;
+const UnsubscribeCreate409 = ConflictError;
+const UnsubscribeCreate422 = ValidationError;
+const UnsubscribeCreate500 = InternalError;
+const UnsubscribeCreate504 = GatewayTimeoutError;
+const UnsubscribeRemovePathParams = /* @__PURE__ */ Schema.Struct({ id: UnsubscribeId });
+const UnsubscribeRemove200 = /* @__PURE__ */ Schema.Struct({ success: Schema.Boolean });
+const UnsubscribeRemove401 = UnauthorizedError;
+const UnsubscribeRemove403 = ForbiddenError;
+const UnsubscribeRemove404 = ResourceNotFoundError;
+const UnsubscribeRemove409 = ConflictError;
+const UnsubscribeRemove422 = ValidationError;
+const UnsubscribeRemove500 = InternalError;
+const UnsubscribeRemove504 = GatewayTimeoutError;
+const UnsubscribeUpdatePathParams = /* @__PURE__ */ Schema.Struct({ id: UnsubscribeId });
+const UnsubscribeUpdateRequestJson = /* @__PURE__ */ Schema.Struct({
+	name: Schema.optionalKey(Schema.Union([Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })), Schema.Null])),
+	description: Schema.optionalKey(Schema.Union([Schema.Union([Schema.String, Schema.Null]), Schema.Null]))
+});
+const UnsubscribeUpdate200 = /* @__PURE__ */ Schema.Struct({
+	id: UnsubscribeId,
+	organizationId: Schema.String,
+	name: Schema.String,
+	description: Schema.Union([Schema.String, Schema.Null]),
+	isDefault: Schema.Boolean,
+	memberCount: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	createdAt: Schema.String,
+	updatedAt: Schema.String
+});
+const UnsubscribeUpdate401 = UnauthorizedError;
+const UnsubscribeUpdate403 = ForbiddenError;
+const UnsubscribeUpdate404 = ResourceNotFoundError;
+const UnsubscribeUpdate422 = ValidationError;
+const UnsubscribeUpdate500 = InternalError;
+const UnsubscribeUpdate504 = GatewayTimeoutError;
+const UnsubscribeSetDefaultPathParams = /* @__PURE__ */ Schema.Struct({ id: UnsubscribeId });
+const UnsubscribeSetDefault200 = /* @__PURE__ */ Schema.Struct({
+	id: UnsubscribeId,
+	organizationId: Schema.String,
+	name: Schema.String,
+	description: Schema.Union([Schema.String, Schema.Null]),
+	isDefault: Schema.Boolean,
+	memberCount: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	createdAt: Schema.String,
+	updatedAt: Schema.String
+});
+const UnsubscribeSetDefault401 = UnauthorizedError;
+const UnsubscribeSetDefault403 = ForbiddenError;
+const UnsubscribeSetDefault404 = ResourceNotFoundError;
+const UnsubscribeSetDefault422 = ValidationError;
+const UnsubscribeSetDefault500 = InternalError;
+const UnsubscribeSetDefault504 = GatewayTimeoutError;
+const UnsubscribeListMembersPathParams = /* @__PURE__ */ Schema.Struct({ id: UnsubscribeId });
+const UnsubscribeListMembersQuery = /* @__PURE__ */ Schema.Struct({
+	limit: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	cursor: Schema.optionalKey(Schema.Union([Cursor, Schema.Null]))
+});
+const UnsubscribeListMembers200 = UnsubscribeGroupMemberPage;
+const UnsubscribeListMembers401 = UnauthorizedError;
+const UnsubscribeListMembers403 = ForbiddenError;
+const UnsubscribeListMembers404 = ResourceNotFoundError;
+const UnsubscribeListMembers422 = ValidationError;
+const UnsubscribeListMembers500 = InternalError;
+const UnsubscribeListMembers504 = GatewayTimeoutError;
+const UnsubscribeAddEmailsPathParams = /* @__PURE__ */ Schema.Struct({ id: UnsubscribeId });
+const UnsubscribeAddEmailsRequestJson = /* @__PURE__ */ Schema.Struct({
+	emails: Schema.Array(Schema.String).check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })),
+	source: Schema.optionalKey(Schema.Union([Schema.Union([
+		Schema.Literal("link"),
+		Schema.Literal("api"),
+		Schema.Literal("manual"),
+		Schema.Literal("complaint")
+	]), Schema.Null]))
+});
+const UnsubscribeAddEmails200 = /* @__PURE__ */ Schema.Struct({
+	added: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	skipped: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" }))
+});
+const UnsubscribeAddEmails401 = UnauthorizedError;
+const UnsubscribeAddEmails403 = ForbiddenError;
+const UnsubscribeAddEmails404 = ResourceNotFoundError;
+const UnsubscribeAddEmails422 = ValidationError;
+const UnsubscribeAddEmails500 = InternalError;
+const UnsubscribeAddEmails504 = GatewayTimeoutError;
+const UnsubscribeRemoveEmailsPathParams = /* @__PURE__ */ Schema.Struct({ id: UnsubscribeId });
+const UnsubscribeRemoveEmailsRequestJson = /* @__PURE__ */ Schema.Struct({ emails: Schema.Array(Schema.String).check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })) });
+const UnsubscribeRemoveEmails200 = /* @__PURE__ */ Schema.Struct({ removed: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })) });
+const UnsubscribeRemoveEmails401 = UnauthorizedError;
+const UnsubscribeRemoveEmails403 = ForbiddenError;
+const UnsubscribeRemoveEmails404 = ResourceNotFoundError;
+const UnsubscribeRemoveEmails422 = ValidationError;
+const UnsubscribeRemoveEmails500 = InternalError;
+const UnsubscribeRemoveEmails504 = GatewayTimeoutError;
+const UnsubscribeCheckSubscriptionQuery = /* @__PURE__ */ Schema.Struct({
+	email: Schema.String,
+	groupIds: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]))
+});
+const UnsubscribeCheckSubscription200 = /* @__PURE__ */ Schema.Struct({
+	email: Schema.String,
+	unsubscribedGroups: Schema.Array(Schema.Struct({
+		groupId: Schema.String,
+		groupName: Schema.String,
+		unsubscribedAt: Schema.String
+	}))
+});
+const UnsubscribeCheckSubscription401 = UnauthorizedError;
+const UnsubscribeCheckSubscription403 = ForbiddenError;
+const UnsubscribeCheckSubscription422 = ValidationError;
+const UnsubscribeCheckSubscription500 = InternalError;
+const UnsubscribeCheckSubscription504 = GatewayTimeoutError;
+var UnsubscribeGroupsGroup = class extends HttpApiGroup.make("Unsubscribe Groups").add(HttpApiEndpoint.get("unsubscribeList", "/v1/unsubscribe-groups", {
+	success: UnsubscribeList200,
+	error: [
+		UnsubscribeList401.pipe(HttpApiSchema.status(401)),
+		UnsubscribeList403.pipe(HttpApiSchema.status(403)),
+		UnsubscribeList422.pipe(HttpApiSchema.status(422)),
+		UnsubscribeList500,
+		UnsubscribeList504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.list").annotate(OpenApi.Summary, "List unsubscribe groups").annotate(OpenApi.Description, "Returns every unsubscribe group in the organization, the default group first, then by name. An organization holds at most 200, so the list is never paged."), HttpApiEndpoint.post("unsubscribeCreate", "/v1/unsubscribe-groups", {
+	payload: UnsubscribeCreateRequestJson,
+	success: UnsubscribeCreate201.pipe(HttpApiSchema.status(201)),
+	error: [
+		UnsubscribeCreate401.pipe(HttpApiSchema.status(401)),
+		UnsubscribeCreate403.pipe(HttpApiSchema.status(403)),
+		UnsubscribeCreate409.pipe(HttpApiSchema.status(409)),
+		UnsubscribeCreate422.pipe(HttpApiSchema.status(422)),
+		UnsubscribeCreate500,
+		UnsubscribeCreate504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.create").annotate(OpenApi.Summary, "Create an unsubscribe group").annotate(OpenApi.Description, "Creates a new unsubscribe group and returns it with a 201 Created status. An organization holds at most 200 groups."), HttpApiEndpoint.delete("unsubscribeRemove", "/v1/unsubscribe-groups/:id", {
+	params: UnsubscribeRemovePathParams,
+	success: UnsubscribeRemove200,
+	error: [
+		UnsubscribeRemove401.pipe(HttpApiSchema.status(401)),
+		UnsubscribeRemove403.pipe(HttpApiSchema.status(403)),
+		UnsubscribeRemove404.pipe(HttpApiSchema.status(404)),
+		UnsubscribeRemove409.pipe(HttpApiSchema.status(409)),
+		UnsubscribeRemove422.pipe(HttpApiSchema.status(422)),
+		UnsubscribeRemove500,
+		UnsubscribeRemove504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.remove").annotate(OpenApi.Summary, "Delete an unsubscribe group").annotate(OpenApi.Description, "Permanently deletes an unsubscribe group by its ID. The default group cannot be deleted; make another group the default first. A group a scheduled or running campaign uses cannot be deleted until that run finishes or is cancelled."), HttpApiEndpoint.patch("unsubscribeUpdate", "/v1/unsubscribe-groups/:id", {
+	params: UnsubscribeUpdatePathParams,
+	payload: UnsubscribeUpdateRequestJson,
+	success: UnsubscribeUpdate200,
+	error: [
+		UnsubscribeUpdate401.pipe(HttpApiSchema.status(401)),
+		UnsubscribeUpdate403.pipe(HttpApiSchema.status(403)),
+		UnsubscribeUpdate404.pipe(HttpApiSchema.status(404)),
+		UnsubscribeUpdate422.pipe(HttpApiSchema.status(422)),
+		UnsubscribeUpdate500,
+		UnsubscribeUpdate504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.update").annotate(OpenApi.Summary, "Update an unsubscribe group").annotate(OpenApi.Description, "Updates the name or description of an unsubscribe group."), HttpApiEndpoint.post("unsubscribeSetDefault", "/v1/unsubscribe-groups/:id/default", {
+	params: UnsubscribeSetDefaultPathParams,
+	success: UnsubscribeSetDefault200,
+	error: [
+		UnsubscribeSetDefault401.pipe(HttpApiSchema.status(401)),
+		UnsubscribeSetDefault403.pipe(HttpApiSchema.status(403)),
+		UnsubscribeSetDefault404.pipe(HttpApiSchema.status(404)),
+		UnsubscribeSetDefault422.pipe(HttpApiSchema.status(422)),
+		UnsubscribeSetDefault500,
+		UnsubscribeSetDefault504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.setDefault").annotate(OpenApi.Summary, "Make an unsubscribe group the default").annotate(OpenApi.Description, "Makes this group the organization's default: campaigns that name no group, and whose template and sending domain name none, unsubscribe recipients from it."), HttpApiEndpoint.get("unsubscribeListMembers", "/v1/unsubscribe-groups/:id/members", {
+	params: UnsubscribeListMembersPathParams,
+	query: UnsubscribeListMembersQuery,
+	success: UnsubscribeListMembers200,
+	error: [
+		UnsubscribeListMembers401.pipe(HttpApiSchema.status(401)),
+		UnsubscribeListMembers403.pipe(HttpApiSchema.status(403)),
+		UnsubscribeListMembers404.pipe(HttpApiSchema.status(404)),
+		UnsubscribeListMembers422.pipe(HttpApiSchema.status(422)),
+		UnsubscribeListMembers500,
+		UnsubscribeListMembers504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.listMembers").annotate(OpenApi.Summary, "List unsubscribe group members").annotate(OpenApi.Description, "Returns the email addresses in an unsubscribe group, newest first. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page."), HttpApiEndpoint.post("unsubscribeAddEmails", "/v1/unsubscribe-groups/:id/members", {
+	params: UnsubscribeAddEmailsPathParams,
+	payload: UnsubscribeAddEmailsRequestJson,
+	success: UnsubscribeAddEmails200,
+	error: [
+		UnsubscribeAddEmails401.pipe(HttpApiSchema.status(401)),
+		UnsubscribeAddEmails403.pipe(HttpApiSchema.status(403)),
+		UnsubscribeAddEmails404.pipe(HttpApiSchema.status(404)),
+		UnsubscribeAddEmails422.pipe(HttpApiSchema.status(422)),
+		UnsubscribeAddEmails500,
+		UnsubscribeAddEmails504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.addEmails").annotate(OpenApi.Summary, "Add contacts to an unsubscribe group").annotate(OpenApi.Description, "Adds one or more email addresses to an unsubscribe group and returns the number added and the number skipped."), HttpApiEndpoint.delete("unsubscribeRemoveEmails", "/v1/unsubscribe-groups/:id/members", {
+	params: UnsubscribeRemoveEmailsPathParams,
+	payload: UnsubscribeRemoveEmailsRequestJson,
+	success: UnsubscribeRemoveEmails200,
+	error: [
+		UnsubscribeRemoveEmails401.pipe(HttpApiSchema.status(401)),
+		UnsubscribeRemoveEmails403.pipe(HttpApiSchema.status(403)),
+		UnsubscribeRemoveEmails404.pipe(HttpApiSchema.status(404)),
+		UnsubscribeRemoveEmails422.pipe(HttpApiSchema.status(422)),
+		UnsubscribeRemoveEmails500,
+		UnsubscribeRemoveEmails504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.removeEmails").annotate(OpenApi.Summary, "Remove contacts from an unsubscribe group").annotate(OpenApi.Description, "Removes one or more email addresses from an unsubscribe group and returns the number removed."), HttpApiEndpoint.get("unsubscribeCheckSubscription", "/v1/unsubscribe-groups/check", {
+	query: UnsubscribeCheckSubscriptionQuery,
+	success: UnsubscribeCheckSubscription200,
+	error: [
+		UnsubscribeCheckSubscription401.pipe(HttpApiSchema.status(401)),
+		UnsubscribeCheckSubscription403.pipe(HttpApiSchema.status(403)),
+		UnsubscribeCheckSubscription422.pipe(HttpApiSchema.status(422)),
+		UnsubscribeCheckSubscription500,
+		UnsubscribeCheckSubscription504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "unsubscribe.checkSubscription").annotate(OpenApi.Summary, "Check unsubscribe group membership").annotate(OpenApi.Description, "Returns the unsubscribe groups that an email address has unsubscribed from, optionally limited to a specified set of groups.")).annotate(OpenApi.Description, "Manage unsubscribe groups and members") {};
+//#endregion
+export { UnsubscribeAddEmails200, UnsubscribeAddEmails401, UnsubscribeAddEmails403, UnsubscribeAddEmails404, UnsubscribeAddEmails422, UnsubscribeAddEmails500, UnsubscribeAddEmails504, UnsubscribeAddEmailsPathParams, UnsubscribeAddEmailsRequestJson, UnsubscribeCheckSubscription200, UnsubscribeCheckSubscription401, UnsubscribeCheckSubscription403, UnsubscribeCheckSubscription422, UnsubscribeCheckSubscription500, UnsubscribeCheckSubscription504, UnsubscribeCheckSubscriptionQuery, UnsubscribeCreate201, UnsubscribeCreate401, UnsubscribeCreate403, UnsubscribeCreate409, UnsubscribeCreate422, UnsubscribeCreate500, UnsubscribeCreate504, UnsubscribeCreateRequestJson, UnsubscribeGroupList, UnsubscribeGroupMemberPage, UnsubscribeGroupsGroup, UnsubscribeList200, UnsubscribeList401, UnsubscribeList403, UnsubscribeList422, UnsubscribeList500, UnsubscribeList504, UnsubscribeListMembers200, UnsubscribeListMembers401, UnsubscribeListMembers403, UnsubscribeListMembers404, UnsubscribeListMembers422, UnsubscribeListMembers500, UnsubscribeListMembers504, UnsubscribeListMembersPathParams, UnsubscribeListMembersQuery, UnsubscribeRemove200, UnsubscribeRemove401, UnsubscribeRemove403, UnsubscribeRemove404, UnsubscribeRemove409, UnsubscribeRemove422, UnsubscribeRemove500, UnsubscribeRemove504, UnsubscribeRemoveEmails200, UnsubscribeRemoveEmails401, UnsubscribeRemoveEmails403, UnsubscribeRemoveEmails404, UnsubscribeRemoveEmails422, UnsubscribeRemoveEmails500, UnsubscribeRemoveEmails504, UnsubscribeRemoveEmailsPathParams, UnsubscribeRemoveEmailsRequestJson, UnsubscribeRemovePathParams, UnsubscribeSetDefault200, UnsubscribeSetDefault401, UnsubscribeSetDefault403, UnsubscribeSetDefault404, UnsubscribeSetDefault422, UnsubscribeSetDefault500, UnsubscribeSetDefault504, UnsubscribeSetDefaultPathParams, UnsubscribeUpdate200, UnsubscribeUpdate401, UnsubscribeUpdate403, UnsubscribeUpdate404, UnsubscribeUpdate422, UnsubscribeUpdate500, UnsubscribeUpdate504, UnsubscribeUpdatePathParams, UnsubscribeUpdateRequestJson };
+
+//# sourceMappingURL=unsubscribe-groups.js.map