ocm-sdk 0.2.0-beta

package/src/internal/utils/values.ts

@@ -0,0 +1,105 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { OcmError } from '../../core/error';
+
+// https://url.spec.whatwg.org/#url-scheme-string
+const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
+
+export const isAbsoluteURL = (url: string): boolean => {
+  return startsWithSchemeRegexp.test(url);
+};
+
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
+/** Returns an object if the given value isn't an object, otherwise returns as-is */
+export function maybeObj(x: unknown): object {
+  if (typeof x !== 'object') {
+    return {};
+  }
+
+  return x ?? {};
+}
+
+// https://stackoverflow.com/a/34491287
+export function isEmptyObj(obj: Object | null | undefined): boolean {
+  if (!obj) return true;
+  for (const _k in obj) return false;
+  return true;
+}
+
+// https://eslint.org/docs/latest/rules/no-prototype-builtins
+export function hasOwn<T extends object = object>(obj: T, key: PropertyKey): key is keyof T {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+
+export function isObj(obj: unknown): obj is Record<string, unknown> {
+  return obj != null && typeof obj === 'object' && !Array.isArray(obj);
+}
+
+export const ensurePresent = <T>(value: T | null | undefined): T => {
+  if (value == null) {
+    throw new OcmError(`Expected a value to be given but received ${value} instead.`);
+  }
+
+  return value;
+};
+
+export const validatePositiveInteger = (name: string, n: unknown): number => {
+  if (typeof n !== 'number' || !Number.isInteger(n)) {
+    throw new OcmError(`${name} must be an integer`);
+  }
+  if (n < 0) {
+    throw new OcmError(`${name} must be a positive integer`);
+  }
+  return n;
+};
+
+export const coerceInteger = (value: unknown): number => {
+  if (typeof value === 'number') return Math.round(value);
+  if (typeof value === 'string') return parseInt(value, 10);
+
+  throw new OcmError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceFloat = (value: unknown): number => {
+  if (typeof value === 'number') return value;
+  if (typeof value === 'string') return parseFloat(value);
+
+  throw new OcmError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+};
+
+export const coerceBoolean = (value: unknown): boolean => {
+  if (typeof value === 'boolean') return value;
+  if (typeof value === 'string') return value === 'true';
+  return Boolean(value);
+};
+
+export const maybeCoerceInteger = (value: unknown): number | undefined => {
+  if (value === undefined) {
+    return undefined;
+  }
+  return coerceInteger(value);
+};
+
+export const maybeCoerceFloat = (value: unknown): number | undefined => {
+  if (value === undefined) {
+    return undefined;
+  }
+  return coerceFloat(value);
+};
+
+export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
+  if (value === undefined) {
+    return undefined;
+  }
+  return coerceBoolean(value);
+};
+
+export const safeJSON = (text: string) => {
+  try {
+    return JSON.parse(text);
+  } catch (err) {
+    return undefined;
+  }
+};

package/src/internal/utils.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/resource.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/resource instead */
+export * from './core/resource';

package/src/resources/comment.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Comment extends APIResource {
+  /**
+   * Submit a user comment or checkin for a specific charging location
+   *
+   * @example
+   * ```ts
+   * const response = await client.comment.submit({
+   *   chargePointID: 0,
+   *   comment: 'string',
+   *   rating: 3,
+   *   relatedURL: 'string',
+   *   userName: 'string',
+   * });
+   * ```
+   */
+  submit(body: CommentSubmitParams, options?: RequestOptions): APIPromise<CommentSubmitResponse> {
+    return this._client.post('/comment', { body, ...options });
+  }
+}
+
+export interface CommentSubmitResponse {
+  description: string;
+
+  status: string;
+}
+
+export interface CommentSubmitParams {
+  /**
+   * This must be a valid POI ID
+   */
+  chargePointID: number;
+
+  /**
+   * Optional valid CheckStatusTypeID to indicate overall catgeory and
+   * success/failure to use equipment e.g. 10 = Charged Successfully.
+   */
+  checkinStatusTypeID?: number;
+
+  /**
+   * This is an optional comment to describe the charging experience, may include
+   * guidance for future users.
+   */
+  comment?: string;
+
+  /**
+   * This must be a valid Comment Type ID as per UserCommentTypes found in Core
+   * Reference Data. If left as null then General Comment will be used.
+   */
+  commentTypeID?: number;
+
+  /**
+   * Optional integer rating between 1 = Worst, 5 = Best.
+   */
+  rating?: number;
+
+  /**
+   * Optional website URL for related information
+   */
+  relatedURL?: string;
+
+  /**
+   * This is an optional name to associate with the submission, for authenticated
+   * users their profile username is used.
+   */
+  userName?: string;
+}
+
+export declare namespace Comment {
+  export {
+    type CommentSubmitResponse as CommentSubmitResponse,
+    type CommentSubmitParams as CommentSubmitParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Comment, type CommentSubmitResponse, type CommentSubmitParams } from './comment';
+export { Mediaitem, type MediaitemCreateResponse, type MediaitemCreateParams } from './mediaitem';
+export { OpenAPI, type OpenAPIRetrieveResponse } from './openapi';
+export { Poi, type PoiListResponse, type PoiListParams } from './poi';
+export { Profile, type ProfileAuthenticateResponse, type ProfileAuthenticateParams } from './profile';
+export {
+  Referencedata,
+  type Country,
+  type ReferencedataRetrieveResponse,
+  type ReferencedataRetrieveParams,
+} from './referencedata';

package/src/resources/mediaitem.ts

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Mediaitem extends APIResource {
+  /**
+   * Submit a photo for a specific charging location
+   *
+   * @example
+   * ```ts
+   * const mediaitem = await client.mediaitem.create({
+   *   chargePointID: 1234,
+   *   imageDataBase64:
+   *     'data:image/jpeg;base64,<BASE64_ENCODED_DATA>',
+   *   comment: 'An example comment',
+   * });
+   * ```
+   */
+  create(body: MediaitemCreateParams, options?: RequestOptions): APIPromise<MediaitemCreateResponse> {
+    return this._client.post('/mediaitem', { body, ...options });
+  }
+}
+
+export interface MediaitemCreateResponse {
+  /**
+   * status code OK
+   */
+  status: string;
+
+  description?: string;
+}
+
+export interface MediaitemCreateParams {
+  /**
+   * ID value for the OCM site (POI) this image relates to.
+   */
+  chargePointID: number;
+
+  /**
+   * BASE64 encoded data
+   */
+  imageDataBase64: string;
+
+  /**
+   * Optional description of image or context
+   */
+  comment?: string;
+}
+
+export declare namespace Mediaitem {
+  export {
+    type MediaitemCreateResponse as MediaitemCreateResponse,
+    type MediaitemCreateParams as MediaitemCreateParams,
+  };
+}

package/src/resources/openapi.ts

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+
+export class OpenAPI extends APIResource {
+  /**
+   * Retrieve the current OpenAPI format (YAML) definition for this API. This is
+   * useful for documentation tools, mocking, testing and client generation.
+   */
+  retrieve(options?: RequestOptions): APIPromise<unknown> {
+    return this._client.get('/openapi', {
+      ...options,
+      headers: buildHeaders([{ Accept: 'text/plain' }, options?.headers]),
+    });
+  }
+}
+
+export type OpenAPIRetrieveResponse = unknown;
+
+export declare namespace OpenAPI {
+  export { type OpenAPIRetrieveResponse as OpenAPIRetrieveResponse };
+}