Merge pull request #351 from platformsh/add-and-fix-types

add and fix types

Author: tlattimore

src/index.ts

@@ -6,11 +6,13 @@ import type { ClientConfiguration } from "./config";
 import { getConfig, setConfig } from "./config";
 import { entities } from "./model";
 import type { Activity } from "./model/Activity";
+import type { EnvironmentAccessRole } from "./model/EnvironmentAccess";
 import type {
   CreateAccessParams,
   DeleteAccessParams,
   UpdateAccessParams
 } from "./model/EnvironmentType";
+import type { InvitationEnvironmentType } from "./model/Invitation";
 import type { Me } from "./model/Me";
 import type { APIObject } from "./model/Ressource";
 import type { TicketQueryParams } from "./model/Ticket";
@@ -113,12 +115,6 @@ export default class Client {
 
   /**
    * Get a single project by its ID.
-   *
-   * @param string id
-   * @param string hostname
-   * @param bool   https
-   *
-   * @return Project|false
    */
   async getProject(id: string) {
     return entities.Project.get({ id });
@@ -158,7 +154,7 @@ export default class Client {
   async getEnvironmentActivities(
     projectId: string,
     environmentId: string,
-    type?: string,
+    type?: string | string[],
     starts_at?: Date
   ) {
     const startsAt = starts_at?.toISOString();
@@ -365,7 +361,7 @@ export default class Client {
   async getIntegrationActivities(
     projectId: string,
     integrationId: string,
-    type: string,
+    type: string | string[],
     starts_at?: Date
   ) {
     const { api_url } = getConfig();
@@ -1389,7 +1385,7 @@ export default class Client {
    *
    * @return Promise<Ticket>
    */
-  async updateTicketStatus(ticketId: string, status: string) {
+  async updateTicketStatus(ticketId: string | number, status: string) {
     return entities.Ticket.patch(ticketId, { status }).then(ticket => ticket);
   }
 
@@ -1426,7 +1422,7 @@ export default class Client {
    *
    * @return Promise<Attachment[]>
    */
-  async getTicketAttachments(ticketId: string) {
+  async getTicketAttachments(ticketId: string | number) {
     const response = await entities.Ticket.getAttachments(ticketId);
     const { attachments } = response;
     return Object.entries(attachments || {}).map(([filename, attachment]) => ({
@@ -1443,7 +1439,7 @@ export default class Client {
    *
    * @return Promise<Attachment[]>
    */
-  async getAllTicketAttachments(ticketId: string) {
+  async getAllTicketAttachments(ticketId: string | number) {
     const response = await entities.Ticket.getAllAttachments(ticketId);
     return response.map(attachment => ({
       filename: attachment.filename,
@@ -1518,7 +1514,7 @@ export default class Client {
    * Updates the user profile picture
    *
    * @param {string} userId User identifier
-   * @param {FormData} FormData object containign picture File object to be
+   * @param {FormData} picture object containing picture File object to be
    * uploaded.
    *
    * @returns {Promise<{url: string}>} Promise that returns the url to the new
@@ -1624,8 +1620,8 @@ export default class Client {
     projectId: string,
     role: string,
     permissions: {
-      type: "production" | "development" | "staging";
-      role: "viewer" | "contributor" | "admin";
+      type: InvitationEnvironmentType;
+      role: EnvironmentAccessRole;
     }[],
     force = false
   ) {

src/model/Deployment.ts

@@ -255,6 +255,8 @@ export type DeploymentService = {
   hooks: ServiceHooks;
   crons: Record<string, any>;
   instance_count?: number;
+  stack?: unknown;
+  worker?: Record<string, Record<string, string>>;
 };
 
 export type DeploymentGetParams = {

src/model/EnvironmentAccess.ts

@@ -30,11 +30,14 @@ export type EnvironmentAccessQueryParams = {
   environmentId: string;
 };
 
+export type EnvironmentAccessRole = "admin" | "contributor" | "viewer";
+export type ConsoleAccessRole = EnvironmentAccessRole | "no-access";
+
 export class EnvironmentAccess extends Ressource {
   id: string;
   user: string;
   email: string;
-  role: string;
+  role: EnvironmentAccessRole;
   project: string;
   environment: string;
 

src/model/EnvironmentType.ts

@@ -1,6 +1,7 @@
 import { authenticatedRequest } from "../api";
 import { getConfig } from "../config";
 
+import type { EnvironmentAccessRole } from "./EnvironmentAccess";
 import { ProjectAccess } from "./ProjectAccess";
 import type { APIObject } from "./Ressource";
 import { Ressource } from "./Ressource";
@@ -18,21 +19,19 @@ export type EnvironmentTypeQueryParams = {
   projectId: string;
 };
 
-export type AccessRole = "admin" | "contributor" | "viewer";
-
 export type CreateAccessParams = {
   projectId: string;
   environmentTypeId: string;
   email?: string;
-  role: AccessRole;
+  role: EnvironmentAccessRole;
   user?: string;
 };
 
 export type UpdateAccessParams = {
   projectId: string;
   environmentTypeId: string;
   accessId: string;
-  role: AccessRole;
+  role: EnvironmentAccessRole;
 };
 
 export type DeleteAccessParams = {

src/model/Integration.ts

@@ -102,6 +102,7 @@ type BitbucketAddonCredentials = {
 export class Integration extends Ressource {
   id: string;
   type: string;
+  token_type?: string;
 
   // These properties may or may not exist on this object, depending on which
   // type of integration it is.
@@ -200,6 +201,7 @@ export class Integration extends Ressource {
 
     this.id = integration.id;
     this.type = integration.type;
+    this.token_type = integration.token_type;
     this.app_credentials = integration.app_credentials;
     this.addon_credentials = integration.addon_credentials;
     this.repository = integration.repository;

src/model/Invitation.ts

@@ -1,6 +1,7 @@
 import { authenticatedRequest } from "../api";
 import { getConfig } from "../config";
 
+import type { ConsoleAccessRole } from "./EnvironmentAccess";
 import type { APIObject } from "./Ressource";
 import { Ressource } from "./Ressource";
 
@@ -16,16 +17,37 @@ const creatableField = [
   "force"
 ];
 
+export type InvitationRole = "admin" | "viewer";
+
+export type InvitationEnvironmentType =
+  | "production"
+  | "development"
+  | "staging";
+
 export class Invitation extends Ressource {
   id: string;
-  owner: any;
+  owner: {
+    id: string;
+    display_name: string;
+  };
+
   projectId: string;
-  environments: any[]; // This field is deprecated, use permissions instead
+  /** @deprecated This field is deprecated, use permissions instead */
+  environments: {
+    id?: string;
+    type: InvitationEnvironmentType;
+    role: ConsoleAccessRole;
+    title?: string;
+  }[];
+
   permissions: any[];
   state: string;
   email: string;
-  role: string;
+  role: InvitationRole;
   force: boolean;
+  created_at: string;
+  updated_at: string;
+  finished_at: string;
 
   constructor(invitation: APIObject, url?: string) {
     const { projectId, id } = invitation;
@@ -51,6 +73,9 @@ export class Invitation extends Ressource {
     this.email = invitation.email;
     this.role = invitation.role;
     this.force = invitation.force;
+    this.created_at = invitation.created_at;
+    this.updated_at = invitation.updated_at;
+    this.finished_at = invitation.finished_at;
   }
 
   static async get(projectId: string, id: string) {

src/model/Order.ts

@@ -31,10 +31,10 @@ export type OrderLineItem = {
   end: string;
   unit_price: number;
   quantity: string | number;
-
-  consumption: number;
+  consumption: string | number;
   duration: number;
-  id: false;
+  exclude_from_invoice?: boolean;
+  id: string;
   organization: string;
   plan_record_id: string;
   proration: number;
@@ -47,6 +47,7 @@ export type OrderLineItem = {
   }[];
   total_price: number;
   total_price_formatted: string;
+  unit_price_formatted?: string;
 };
 
 export class Order extends Ressource {

src/model/OrganizationSubscription.ts

@@ -22,8 +22,38 @@ export type OrganizationSubscriptionQueryParams = {
 
 // @ts-expect-error solve the query function inheritance ts error
 export class OrganizationSubscription extends Subscription {
-  organization_id: string;
-  project_region: string;
+  agency_site: boolean;
+  big_dev: null;
+  big_dev_service: null;
+  continuous_profiling: null;
+  created_at: string;
+  enterprise_tag: string;
+  environments: number;
+  fastly_service_ids: null;
+  green: boolean;
+  hipaa: boolean;
+  id: string;
+  invoiced: boolean;
+  is_trial_plan: boolean;
+  locked: null;
+  options_url: string;
+  owner: string;
+  owner_info: {
+    type: string;
+  };
+
+  plan: string;
+  project_id: string;
+  project_notes: string;
+  project_region_label: string;
+  project_title: string;
+  project_ui: string;
+  services: unknown[];
+  storage: number;
+  support_tier: string;
+  updated_at: string;
+  user_licenses: number;
+  vendor: string;
 
   constructor(subscription: APIObject, customUrl?: string) {
     const { organizationId } = subscription;
@@ -39,8 +69,35 @@ export class OrganizationSubscription extends Subscription {
     this._required = ["project_region", "organization_id"];
     this._creatableField.push("organizationId");
 
-    this.organization_id = organizationId;
-    this.project_region = subscription.project_region;
+    this.agency_site = subscription.agency_site;
+    this.big_dev = subscription.big_dev;
+    this.big_dev_service = subscription.big_dev_service;
+    this.continuous_profiling = subscription.continuous_profiling;
+    this.created_at = subscription.created_at;
+    this.enterprise_tag = subscription.enterprise_tag;
+    this.environments = subscription.environments;
+    this.fastly_service_ids = subscription.fastly_service_ids;
+    this.green = subscription.green;
+    this.hipaa = subscription.hipaa;
+    this.id = subscription.id;
+    this.invoiced = subscription.invoiced;
+    this.is_trial_plan = subscription.is_trial_plan;
+    this.locked = subscription.locked;
+    this.options_url = subscription.options_url;
+    this.owner = subscription.owner;
+    this.owner_info = subscription.owner_info;
+    this.plan = subscription.plan;
+    this.project_id = subscription.project_id;
+    this.project_notes = subscription.project_notes;
+    this.project_region_label = subscription.project_region_label;
+    this.project_title = subscription.project_title;
+    this.project_ui = subscription.project_ui;
+    this.services = subscription.services;
+    this.storage = subscription.storage;
+    this.support_tier = subscription.support_tier;
+    this.updated_at = subscription.updated_at;
+    this.user_licenses = subscription.user_licenses;
+    this.vendor = subscription.vendor;
   }
 
   static async get(