@distilled.cloud/ovh 0.0.0 → 1.0.0-rc.9

package/src/services/support.ts

@@ -0,0 +1,598 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-ovh). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as T from "../traits.ts";
+import {
+  OvhProtocol,
+  type OvhOpError,
+  type OvhOpContext,
+} from "../protocol.ts";
+import { UnknownOvhError } from "../errors.ts";
+import * as Retry from "../retry.ts";
+
+export type { OvhOpError, OvhOpContext };
+
+/** Ticket request category */
+export type SupportTicketCategoryEnum = "assistance" | "billing" | "incident";
+export const SupportTicketCategoryEnum = /*@__PURE__*/ S.String;
+
+/** Ticket level of impact or urgency (reserved for Business or Enterprise support level accounts) */
+export type SupportTicketImpactUrgencyEnum = "high" | "low" | "medium";
+export const SupportTicketImpactUrgencyEnum = /*@__PURE__*/ S.String;
+
+/** Ticket product */
+export type SupportTicketProductEnum =
+  | "adsl"
+  | "cdn"
+  | "dedicated"
+  | "dedicated-billing"
+  | "dedicated-other"
+  | "dedicatedcloud"
+  | "domain"
+  | "exchange"
+  | "fax"
+  | "hosting"
+  | "housing"
+  | "iaas"
+  | "mail"
+  | "network"
+  | "publiccloud"
+  | "sms"
+  | "ssl"
+  | "storage"
+  | "telecom-billing"
+  | "telecom-other"
+  | "vac"
+  | "voip"
+  | "vps"
+  | "web-billing"
+  | "web-other";
+export const SupportTicketProductEnum = /*@__PURE__*/ S.String;
+
+/** Ticket request subcategory */
+export type SupportTicketSubCategoryEnum =
+  | "alerts"
+  | "autorenew"
+  | "bill"
+  | "down"
+  | "inProgress"
+  | "new"
+  | "other"
+  | "perfs"
+  | "start"
+  | "usage";
+export const SupportTicketSubCategoryEnum = /*@__PURE__*/ S.String;
+
+/** DEPRECATED - Ticket type (criticalIntervention requires VIP support level) */
+export type SupportTicketTypeEnum = "criticalIntervention" | "genericRequest";
+export const SupportTicketTypeEnum = /*@__PURE__*/ S.String;
+
+/** List of e-mail addresses to notify on ticket updates (max. 10) */
+export type CreateSupportTicketRequestWatchersList = Array<string>;
+export const CreateSupportTicketRequestWatchersList = /*@__PURE__*/ S.Array(
+  S.String,
+) as any as S.Schema<CreateSupportTicketRequestWatchersList>;
+
+export interface CreateSupportTicketRequest {
+  /** Ticket message body */
+  body: string;
+  /** Ticket message category */
+  category?: SupportTicketCategoryEnum | (string & {});
+  /** Ticket impact (reserved for Business or Enterprise support level accounts) */
+  impact?: SupportTicketImpactUrgencyEnum | (string & {});
+  /** Ticket message product */
+  product?: SupportTicketProductEnum | (string & {});
+  /** Ticket message service name */
+  serviceName?: string;
+  /** Ticket message subcategory */
+  subcategory?: SupportTicketSubCategoryEnum | (string & {});
+  /** Ticket message subject */
+  subject: string;
+  /** DEPRECATED - Ticket type (criticalIntervention requires VIP support level) */
+  type?: SupportTicketTypeEnum | (string & {});
+  /** Ticket urgency (reserved for Business or Enterprise support level accounts) */
+  urgency?: SupportTicketImpactUrgencyEnum | (string & {});
+  /** List of e-mail addresses to notify on ticket updates (max. 10) */
+  watchers?: CreateSupportTicketRequestWatchersList;
+}
+export const CreateSupportTicketRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    body: S.String,
+    category: S.optional(SupportTicketCategoryEnum),
+    impact: S.optional(SupportTicketImpactUrgencyEnum),
+    product: S.optional(SupportTicketProductEnum),
+    serviceName: S.optional(S.String),
+    subcategory: S.optional(SupportTicketSubCategoryEnum),
+    subject: S.String,
+    type: S.optional(SupportTicketTypeEnum),
+    urgency: S.optional(SupportTicketImpactUrgencyEnum),
+    watchers: S.optional(CreateSupportTicketRequestWatchersList),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/support/tickets/create", code: 200 }),
+  ),
+).annotate({
+  identifier: "CreateSupportTicketRequest",
+}) as any as S.Schema<CreateSupportTicketRequest>;
+
+/** Newly created support identifiers */
+export interface SupportNewMessageInfo {
+  /** Notice or warning */
+  additionalNotice?: string | null;
+  /** Message identifier */
+  messageId?: number;
+  /** Ticket identifier */
+  ticketId?: number;
+  /** Ticket external number */
+  ticketNumber?: number;
+}
+export const SupportNewMessageInfo = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    additionalNotice: S.optional(S.NullOr(S.String)),
+    messageId: S.optional(S.Number),
+    ticketId: S.optional(S.Number),
+    ticketNumber: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "SupportNewMessageInfo",
+}) as any as S.Schema<SupportNewMessageInfo>;
+
+export interface CreateSupportTicketCloseRequest {
+  /** internal ticket identifier */
+  ticketId: number;
+}
+export const CreateSupportTicketCloseRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ticketId: S.Number.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/support/tickets/{ticketId}/close",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "CreateSupportTicketCloseRequest",
+}) as any as S.Schema<CreateSupportTicketCloseRequest>;
+
+export interface CreateSupportTicketCloseResponse {}
+export const CreateSupportTicketCloseResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "CreateSupportTicketCloseResponse",
+}) as any as S.Schema<CreateSupportTicketCloseResponse>;
+
+export interface CreateSupportTicketReopenRequest {
+  /** internal ticket identifier */
+  ticketId: number;
+  /** ticket reopen reason */
+  body: string;
+}
+export const CreateSupportTicketReopenRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ticketId: S.Number.pipe(T.Label()),
+    body: S.String,
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/support/tickets/{ticketId}/reopen",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "CreateSupportTicketReopenRequest",
+}) as any as S.Schema<CreateSupportTicketReopenRequest>;
+
+export interface CreateSupportTicketReopenResponse {}
+export const CreateSupportTicketReopenResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "CreateSupportTicketReopenResponse",
+}) as any as S.Schema<CreateSupportTicketReopenResponse>;
+
+export interface CreateSupportTicketScoreRequest {
+  /** internal ticket identifier */
+  ticketId: number;
+  /** ticket score */
+  score: string;
+  /** ticket comment about the score */
+  scoreComment?: string;
+}
+export const CreateSupportTicketScoreRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ticketId: S.Number.pipe(T.Label()),
+    score: S.String,
+    scoreComment: S.optional(S.String),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/support/tickets/{ticketId}/score",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "CreateSupportTicketScoreRequest",
+}) as any as S.Schema<CreateSupportTicketScoreRequest>;
+
+export interface CreateSupportTicketScoreResponse {}
+export const CreateSupportTicketScoreResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "CreateSupportTicketScoreResponse",
+}) as any as S.Schema<CreateSupportTicketScoreResponse>;
+
+export interface GetSupportTicketRequest {
+  /** internal identifier ticket */
+  ticketId: number;
+}
+export const GetSupportTicketRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ticketId: S.Number.pipe(T.Label()),
+  }).pipe(
+    T.Http({ method: "GET", uri: "/support/tickets/{ticketId}", code: 200 }),
+  ),
+).annotate({
+  identifier: "GetSupportTicketRequest",
+}) as any as S.Schema<GetSupportTicketRequest>;
+
+/** Message sender type */
+export type SupportMessageSenderEnum = "customer" | "support";
+export const SupportMessageSenderEnum = /*@__PURE__*/ S.String;
+
+/** Support ticket statuses */
+export type SupportTicketStatusEnum = "closed" | "open" | "unknown";
+export const SupportTicketStatusEnum = /*@__PURE__*/ S.String;
+
+/** Support Ticket */
+export interface SupportTicket {
+  /** Customer account identifier */
+  accountId?: string;
+  /** Can this ticket be closed or not */
+  canBeClosed?: boolean;
+  /** Ticket request category */
+  category?: SupportTicketCategoryEnum | null;
+  /** Ticket creation date */
+  creationDate?: string;
+  /** Sender type of last message */
+  lastMessageFrom?: SupportMessageSenderEnum;
+  /** Product service concerned by ticket */
+  product?: SupportTicketProductEnum | null;
+  /** Ticket score */
+  score?: string;
+  /** Name of service concerned by ticket */
+  serviceName?: string | null;
+  /** State of ticket */
+  state?: SupportTicketStatusEnum;
+  /** Ticket subject */
+  subject?: string;
+  /** Ticket identifier */
+  ticketId?: number;
+  /** Ticket external number */
+  ticketNumber?: number;
+  /** Ticket type */
+  type?: SupportTicketTypeEnum;
+  /** Ticket last update date */
+  updateDate?: string;
+}
+export const SupportTicket = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    accountId: S.optional(S.String),
+    canBeClosed: S.optional(S.Boolean),
+    category: S.optional(S.NullOr(SupportTicketCategoryEnum)),
+    creationDate: S.optional(S.String),
+    lastMessageFrom: S.optional(SupportMessageSenderEnum),
+    product: S.optional(S.NullOr(SupportTicketProductEnum)),
+    score: S.optional(S.String),
+    serviceName: S.optional(S.NullOr(S.String)),
+    state: S.optional(SupportTicketStatusEnum),
+    subject: S.optional(S.String),
+    ticketId: S.optional(S.Number),
+    ticketNumber: S.optional(S.Number),
+    type: S.optional(SupportTicketTypeEnum),
+    updateDate: S.optional(S.String),
+  }),
+).annotate({ identifier: "SupportTicket" }) as any as S.Schema<SupportTicket>;
+
+export interface GetSupportTicketCanBeScoredRequest {
+  /** internal ticket identifier */
+  ticketId: number;
+}
+export const GetSupportTicketCanBeScoredRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ticketId: S.Number.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/support/tickets/{ticketId}/canBeScored",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetSupportTicketCanBeScoredRequest",
+}) as any as S.Schema<GetSupportTicketCanBeScoredRequest>;
+
+export type GetSupportTicketCanBeScoredResponse = boolean;
+export const GetSupportTicketCanBeScoredResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Boolean.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "GetSupportTicketCanBeScoredResponse",
+}) as any as S.Schema<GetSupportTicketCanBeScoredResponse>;
+
+export interface ListSupportTicketMessagesRequest {
+  /** internal ticket identifier */
+  ticketId: number;
+}
+export const ListSupportTicketMessagesRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ticketId: S.Number.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/support/tickets/{ticketId}/messages",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "ListSupportTicketMessagesRequest",
+}) as any as S.Schema<ListSupportTicketMessagesRequest>;
+
+/** Support ticket message */
+export interface SupportMessage {
+  /** Message body */
+  body?: string;
+  /** Message creation date */
+  creationDate?: string;
+  /** Message sender type */
+  from?: SupportMessageSenderEnum;
+  /** Message identifier */
+  messageId?: number;
+  /** Ticket identifier */
+  ticketId?: number;
+  /** Message last update date */
+  updateDate?: string;
+}
+export const SupportMessage = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    body: S.optional(S.String),
+    creationDate: S.optional(S.String),
+    from: S.optional(SupportMessageSenderEnum),
+    messageId: S.optional(S.Number),
+    ticketId: S.optional(S.Number),
+    updateDate: S.optional(S.String),
+  }),
+).annotate({ identifier: "SupportMessage" }) as any as S.Schema<SupportMessage>;
+
+export type ListSupportTicketMessagesResponseBodyList = Array<SupportMessage>;
+export const ListSupportTicketMessagesResponseBodyList = /*@__PURE__*/ S.Array(
+  SupportMessage,
+) as any as S.Schema<ListSupportTicketMessagesResponseBodyList>;
+
+export type ListSupportTicketMessagesResponse =
+  ListSupportTicketMessagesResponseBodyList;
+export const ListSupportTicketMessagesResponse = /*@__PURE__*/ S.suspend(() =>
+  ListSupportTicketMessagesResponseBodyList.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "ListSupportTicketMessagesResponse",
+}) as any as S.Schema<ListSupportTicketMessagesResponse>;
+
+export interface ListSupportTicketsRequest {
+  /** Search archived tickets */
+  archived?: boolean;
+  /** Search by ticket category */
+  category?: SupportTicketCategoryEnum | (string & {});
+  /** Tickets pending a customer reply */
+  customerReplyNeeded?: boolean;
+  /** Exclude auto-generated tickets */
+  excludeAutogenerated?: boolean;
+  /** Maximum creation date */
+  maxCreationDate?: string;
+  /** Minimum creation date */
+  minCreationDate?: string;
+  /** Page of tickets to fetch (only if pageSize is defined) */
+  page?: number;
+  /** Number of ticket to fetch */
+  pageSize?: number;
+  /** Search by ticket product */
+  product?: SupportTicketProductEnum | (string & {});
+  /** Ticket message service name */
+  serviceName?: string;
+  /** Status of ticket */
+  status?: SupportTicketStatusEnum | (string & {});
+  /** Search by ticket subject */
+  subject?: string;
+  /** Search by ticket number */
+  ticketNumber?: string;
+}
+export const ListSupportTicketsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    archived: S.optional(S.Boolean.pipe(T.Query())),
+    category: S.optional(SupportTicketCategoryEnum.pipe(T.Query())),
+    customerReplyNeeded: S.optional(S.Boolean.pipe(T.Query())),
+    excludeAutogenerated: S.optional(S.Boolean.pipe(T.Query())),
+    maxCreationDate: S.optional(S.String.pipe(T.Query())),
+    minCreationDate: S.optional(S.String.pipe(T.Query())),
+    page: S.optional(S.Number.pipe(T.Query())),
+    pageSize: S.optional(S.Number.pipe(T.Query())),
+    product: S.optional(SupportTicketProductEnum.pipe(T.Query())),
+    serviceName: S.optional(S.String.pipe(T.Query())),
+    status: S.optional(SupportTicketStatusEnum.pipe(T.Query())),
+    subject: S.optional(S.String.pipe(T.Query())),
+    ticketNumber: S.optional(S.String.pipe(T.Query())),
+  }).pipe(T.Http({ method: "GET", uri: "/support/tickets", code: 200 })),
+).annotate({
+  identifier: "ListSupportTicketsRequest",
+}) as any as S.Schema<ListSupportTicketsRequest>;
+
+export type ListSupportTicketsResponseBodyList = Array<number>;
+export const ListSupportTicketsResponseBodyList = /*@__PURE__*/ S.Array(
+  S.Number,
+) as any as S.Schema<ListSupportTicketsResponseBodyList>;
+
+export type ListSupportTicketsResponse = ListSupportTicketsResponseBodyList;
+export const ListSupportTicketsResponse = /*@__PURE__*/ S.suspend(() =>
+  ListSupportTicketsResponseBodyList.pipe(T.RawResponseRoot()),
+).annotate({
+  identifier: "ListSupportTicketsResponse",
+}) as any as S.Schema<ListSupportTicketsResponse>;
+
+export interface ReplySupportTicketRequest {
+  /** internal ticket identifier */
+  ticketId: number;
+  /** text body of ticket response */
+  body: string;
+}
+export const ReplySupportTicketRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ticketId: S.Number.pipe(T.Label()),
+    body: S.String,
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/support/tickets/{ticketId}/reply",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "ReplySupportTicketRequest",
+}) as any as S.Schema<ReplySupportTicketRequest>;
+
+export interface ReplySupportTicketResponse {}
+export const ReplySupportTicketResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "ReplySupportTicketResponse",
+}) as any as S.Schema<ReplySupportTicketResponse>;
+
+export type CreateSupportTicketError = OvhOpError;
+/** Create a new ticket */
+export const createSupportTicket: API.OperationMethod<
+  CreateSupportTicketRequest,
+  SupportNewMessageInfo,
+  CreateSupportTicketError,
+  OvhOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreateSupportTicketRequest,
+  output: SupportNewMessageInfo,
+  errors: [UnknownOvhError],
+  protocol: OvhProtocol,
+  retry: Retry.Retry,
+}));
+
+export type CreateSupportTicketCloseError = OvhOpError;
+/** Close ticket */
+export const createSupportTicketClose: API.OperationMethod<
+  CreateSupportTicketCloseRequest,
+  CreateSupportTicketCloseResponse,
+  CreateSupportTicketCloseError,
+  OvhOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreateSupportTicketCloseRequest,
+  output: CreateSupportTicketCloseResponse,
+  errors: [UnknownOvhError],
+  protocol: OvhProtocol,
+  retry: Retry.Retry,
+}));
+
+export type CreateSupportTicketReopenError = OvhOpError;
+/** Reopen a ticket */
+export const createSupportTicketReopen: API.OperationMethod<
+  CreateSupportTicketReopenRequest,
+  CreateSupportTicketReopenResponse,
+  CreateSupportTicketReopenError,
+  OvhOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreateSupportTicketReopenRequest,
+  output: CreateSupportTicketReopenResponse,
+  errors: [UnknownOvhError],
+  protocol: OvhProtocol,
+  retry: Retry.Retry,
+}));
+
+export type CreateSupportTicketScoreError = OvhOpError;
+/** Set ticket score */
+export const createSupportTicketScore: API.OperationMethod<
+  CreateSupportTicketScoreRequest,
+  CreateSupportTicketScoreResponse,
+  CreateSupportTicketScoreError,
+  OvhOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreateSupportTicketScoreRequest,
+  output: CreateSupportTicketScoreResponse,
+  errors: [UnknownOvhError],
+  protocol: OvhProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetSupportTicketError = OvhOpError;
+/** Get ticket */
+export const getSupportTicket: API.OperationMethod<
+  GetSupportTicketRequest,
+  SupportTicket,
+  GetSupportTicketError,
+  OvhOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetSupportTicketRequest,
+  output: SupportTicket,
+  errors: [UnknownOvhError],
+  protocol: OvhProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetSupportTicketCanBeScoredError = OvhOpError;
+/** Checks whether ticket can be scored */
+export const getSupportTicketCanBeScored: API.OperationMethod<
+  GetSupportTicketCanBeScoredRequest,
+  GetSupportTicketCanBeScoredResponse,
+  GetSupportTicketCanBeScoredError,
+  OvhOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetSupportTicketCanBeScoredRequest,
+  output: GetSupportTicketCanBeScoredResponse,
+  errors: [UnknownOvhError],
+  protocol: OvhProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListSupportTicketMessagesError = OvhOpError;
+/** Get ticket messages */
+export const listSupportTicketMessages: API.OperationMethod<
+  ListSupportTicketMessagesRequest,
+  ListSupportTicketMessagesResponse,
+  ListSupportTicketMessagesError,
+  OvhOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListSupportTicketMessagesRequest,
+  output: ListSupportTicketMessagesResponse,
+  errors: [UnknownOvhError],
+  protocol: OvhProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ListSupportTicketsError = OvhOpError;
+/** List support tickets identifiers for this service */
+export const listSupportTickets: API.OperationMethod<
+  ListSupportTicketsRequest,
+  ListSupportTicketsResponse,
+  ListSupportTicketsError,
+  OvhOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ListSupportTicketsRequest,
+  output: ListSupportTicketsResponse,
+  errors: [UnknownOvhError],
+  protocol: OvhProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ReplySupportTicketError = OvhOpError;
+/** Reply to ticket */
+export const replySupportTicket: API.OperationMethod<
+  ReplySupportTicketRequest,
+  ReplySupportTicketResponse,
+  ReplySupportTicketError,
+  OvhOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ReplySupportTicketRequest,
+  output: ReplySupportTicketResponse,
+  errors: [UnknownOvhError],
+  protocol: OvhProtocol,
+  retry: Retry.Retry,
+}));