@whiplashmerch/whiplash-api-client 0.0.1

package/dist/generated/v2.1/index.d.ts

@@ -0,0 +1,19 @@
+export * from './BundleItems';
+export * from './ConsumerReturns';
+export * from './Customers';
+export * from './Documents';
+export * from './Items';
+export * from './MetaKeys';
+export * from './NotificationEvents';
+export * from './NotificationSubscriptions';
+export * from './OrderDocuments';
+export * from './OrderItems';
+export * from './Orders';
+export * from './Originators';
+export * from './Public';
+export * from './ScancodeAliases';
+export * from './ShipnoticeItems';
+export * from './Shipnotices';
+export * from './Simulate';
+export * from './Templates';
+export * from './data-contracts';

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './generated';

package/generated/http-client.ts

@@ -0,0 +1,142 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import axios, { AxiosInstance, AxiosRequestConfig, HeadersDefaults, ResponseType } from "axios";
+
+export type QueryParamsType = Record<string | number, any>;
+
+export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
+  /** set parameter to `true` for call `securityWorker` for this request */
+  secure?: boolean;
+  /** request path */
+  path: string;
+  /** content type of request body */
+  type?: ContentType;
+  /** query params */
+  query?: QueryParamsType;
+  /** format of response (i.e. response.json() -> format: "json") */
+  format?: ResponseType;
+  /** request body */
+  body?: unknown;
+}
+
+export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
+
+export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, "data" | "cancelToken"> {
+  securityWorker?: (
+    securityData: SecurityDataType | null,
+  ) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
+  secure?: boolean;
+  format?: ResponseType;
+}
+
+export enum ContentType {
+  Json = "application/json",
+  FormData = "multipart/form-data",
+  UrlEncoded = "application/x-www-form-urlencoded",
+  Text = "text/plain",
+}
+
+export class HttpClient<SecurityDataType = unknown> {
+  public instance: AxiosInstance;
+  private securityData: SecurityDataType | null = null;
+  private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
+  private secure?: boolean;
+  private format?: ResponseType;
+
+  constructor({ securityWorker, secure, format, ...axiosConfig }: ApiConfig<SecurityDataType> = {}) {
+    this.instance = axios.create({ ...axiosConfig, baseURL: axiosConfig.baseURL || "//localhost:3000" });
+    this.secure = secure;
+    this.format = format;
+    this.securityWorker = securityWorker;
+  }
+
+  public setSecurityData = (data: SecurityDataType | null) => {
+    this.securityData = data;
+  };
+
+  protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig {
+    const method = params1.method || (params2 && params2.method);
+
+    return {
+      ...this.instance.defaults,
+      ...params1,
+      ...(params2 || {}),
+      headers: {
+        ...((method && this.instance.defaults.headers[method.toLowerCase() as keyof HeadersDefaults]) || {}),
+        ...(params1.headers || {}),
+        ...((params2 && params2.headers) || {}),
+      },
+    };
+  }
+
+  protected stringifyFormItem(formItem: unknown) {
+    if (typeof formItem === "object" && formItem !== null) {
+      return JSON.stringify(formItem);
+    } else {
+      return `${formItem}`;
+    }
+  }
+
+  protected createFormData(input: Record<string, unknown>): FormData {
+    return Object.keys(input || {}).reduce((formData, key) => {
+      const property = input[key];
+      const propertyContent: any[] = property instanceof Array ? property : [property];
+
+      for (const formItem of propertyContent) {
+        const isFileType = formItem instanceof Blob || formItem instanceof File;
+        formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
+      }
+
+      return formData;
+    }, new FormData());
+  }
+
+  public request = async <T = any, _E = any>({
+    secure,
+    path,
+    type,
+    query,
+    format,
+    body,
+    ...params
+  }: FullRequestParams): Promise<T> => {
+    const secureParams =
+      ((typeof secure === "boolean" ? secure : this.secure) &&
+        this.securityWorker &&
+        (await this.securityWorker(this.securityData))) ||
+      {};
+    const requestParams = this.mergeRequestParams(params, secureParams);
+    const responseFormat = format || this.format || undefined;
+
+    if (type === ContentType.FormData && body && body !== null && typeof body === "object") {
+      body = this.createFormData(body as Record<string, unknown>);
+    }
+
+    if (type === ContentType.Text && body && body !== null && typeof body !== "string") {
+      body = JSON.stringify(body);
+    }
+
+    return this.instance
+      .request({
+        ...requestParams,
+        headers: {
+          ...(requestParams.headers || {}),
+          ...(type && type !== ContentType.FormData ? { "Content-Type": type } : {}),
+        },
+        params: query,
+        responseType: responseFormat,
+        data: body,
+        url: path,
+      })
+      .then((response) => response.data);
+  };
+}

package/generated/index.ts

@@ -0,0 +1,2 @@
+export * from './v2';
+export * from './v2.1';

package/generated/v2/BundleItems.ts

@@ -0,0 +1,67 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { ContentType, HttpClient, RequestParams } from "./../http-client";
+import { APIV2EntitiesApiError, APIV2EntitiesBundleItem, PutApiV2BundleItemsIdPayload } from "./data-contracts";
+
+/**
+ * @description This removes the item from the bundle, but does not affect the item in any other way.
+ *
+ * @tags items
+ * @name DeleteApiV2BundleItemsId
+ * @summary Destroy a bundle item
+ * @request DELETE:/api/v2/bundle_items/{id}
+ */
+export const deleteApiV2BundleItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/bundle_items/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name PutApiV2BundleItemsId
+ * @summary Update a bundle item's quantity
+ * @request PUT:/api/v2/bundle_items/{id}
+ */
+export const putApiV2BundleItemsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV2BundleItemsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/bundle_items/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV2BundleItemsId
+ * @summary Retrieve a bundle item
+ * @request GET:/api/v2/bundle_items/{id}
+ */
+export const getApiV2BundleItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesBundleItem, APIV2EntitiesApiError>({
+    path: `/api/v2/bundle_items/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2/ConsumerReturns.ts

@@ -0,0 +1,265 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { ContentType, HttpClient, RequestParams } from "./../http-client";
+import {
+  APIV2EntitiesApiError,
+  APIV2EntitiesConsumerReturn,
+  APIV2EntitiesCount,
+  APIV2EntitiesMetaFields,
+  APIV2EntitiesResult,
+  GetApiV2ConsumerReturnsCountParams,
+  GetApiV2ConsumerReturnsIdMetaFieldsPayload,
+  GetApiV2ConsumerReturnsParams,
+  PostApiV2ConsumerReturnsBulkPayload,
+  PostApiV2ConsumerReturnsPayload,
+  PutApiV2ConsumerReturnsIdPayload,
+  PutApiV2ConsumerReturnsOriginatorOriginatorIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags originators
+ * @name DeleteApiV2ConsumerReturnsOriginatorOriginatorId
+ * @summary Destroy a consumer return
+ * @request DELETE:/api/v2/consumer_returns/originator/{originator_id}
+ */
+export const deleteApiV2ConsumerReturnsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/originator/${originatorId}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name PutApiV2ConsumerReturnsOriginatorOriginatorId
+ * @summary Update a consumer return
+ * @request PUT:/api/v2/consumer_returns/originator/{originator_id}
+ */
+export const putApiV2ConsumerReturnsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  data: PutApiV2ConsumerReturnsOriginatorOriginatorIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/originator/${originatorId}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV2ConsumerReturnsOriginatorOriginatorId
+ * @summary Retrieve a consumer return
+ * @request GET:/api/v2/consumer_returns/originator/{originator_id}
+ */
+export const getApiV2ConsumerReturnsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesConsumerReturn, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/originator/${originatorId}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags consumer_returns
+ * @name PutApiV2ConsumerReturnsIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2/consumer_returns/{id}/meta_fields
+ */
+export const putApiV2ConsumerReturnsIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags consumer_returns
+ * @name GetApiV2ConsumerReturnsIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2/consumer_returns/{id}/meta_fields
+ */
+export const getApiV2ConsumerReturnsIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV2ConsumerReturnsIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesMetaFields, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name DeleteApiV2ConsumerReturnsId
+ * @summary Destroy a consumer return
+ * @request DELETE:/api/v2/consumer_returns/{id}
+ */
+export const deleteApiV2ConsumerReturnsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name PutApiV2ConsumerReturnsId
+ * @summary Update a consumer return
+ * @request PUT:/api/v2/consumer_returns/{id}
+ */
+export const putApiV2ConsumerReturnsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV2ConsumerReturnsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name GetApiV2ConsumerReturnsId
+ * @summary Retrieve a consumer return
+ * @request GET:/api/v2/consumer_returns/{id}
+ */
+export const getApiV2ConsumerReturnsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesConsumerReturn, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name PostApiV2ConsumerReturns
+ * @summary Create a consumer return
+ * @request POST:/api/v2/consumer_returns
+ */
+export const postApiV2ConsumerReturns = (
+  client: HttpClient,
+  data: PostApiV2ConsumerReturnsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name GetApiV2ConsumerReturns
+ * @summary List all consumer returns
+ * @request GET:/api/v2/consumer_returns
+ */
+export const getApiV2ConsumerReturns = (
+  client: HttpClient,
+  query: GetApiV2ConsumerReturnsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesConsumerReturn[], APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name GetApiV2ConsumerReturnsCount
+ * @summary Count consumer returns
+ * @request GET:/api/v2/consumer_returns/count
+ */
+export const getApiV2ConsumerReturnsCount = (
+  client: HttpClient,
+  query: GetApiV2ConsumerReturnsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created consumer_returns.
+ *
+ * @tags consumer_returns
+ * @name PostApiV2ConsumerReturnsBulk
+ * @summary Create consumer_returns in bulk
+ * @request POST:/api/v2/consumer_returns/bulk
+ */
+export const postApiV2ConsumerReturnsBulk = (
+  client: HttpClient,
+  data: PostApiV2ConsumerReturnsBulkPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesResult, APIV2EntitiesApiError>({
+    path: `/api/v2/consumer_returns/bulk`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2/Customers.ts

@@ -0,0 +1,113 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { ContentType, HttpClient, RequestParams } from "./../http-client";
+import {
+  APIV2EntitiesApiError,
+  APIV2EntitiesCount,
+  APIV2EntitiesCustomer,
+  GetApiV2CustomersCountParams,
+  GetApiV2CustomersParams,
+  PutApiV2CustomersIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags customers
+ * @name GetApiV2CustomersCount
+ * @summary Count customers
+ * @request GET:/api/v2/customers/count
+ */
+export const getApiV2CustomersCount = (
+  client: HttpClient,
+  query: GetApiV2CustomersCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/customers/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags customers
+ * @name GetApiV2Customers
+ * @summary List all customers
+ * @request GET:/api/v2/customers
+ */
+export const getApiV2Customers = (client: HttpClient, query: GetApiV2CustomersParams, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesCustomer[], APIV2EntitiesApiError>({
+    path: `/api/v2/customers`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get resource actions
+ *
+ * @tags customers
+ * @name GetApiV2CustomersActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2/customers/actions
+ */
+export const getApiV2CustomersActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/customers/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * @description Update your customers' information and preferences
+ *
+ * @tags customers
+ * @name PutApiV2CustomersId
+ * @summary Update a customer
+ * @request PUT:/api/v2/customers/{id}
+ */
+export const putApiV2CustomersId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV2CustomersIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCustomer, APIV2EntitiesApiError>({
+    path: `/api/v2/customers/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags customers
+ * @name GetApiV2CustomersId
+ * @summary Retrieve a customer
+ * @request GET:/api/v2/customers/{id}
+ */
+export const getApiV2CustomersId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesCustomer, APIV2EntitiesApiError>({
+    path: `/api/v2/customers/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2/Documents.ts

@@ -0,0 +1,86 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { ContentType, HttpClient, RequestParams } from "./../http-client";
+import {
+  APIV2EntitiesApiError,
+  APIV2EntitiesDocument,
+  GetApiV2DocumentsParams,
+  PostApiV2DocumentsPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags documents
+ * @name PostApiV2Documents
+ * @summary Create a document
+ * @request POST:/api/v2/documents
+ */
+export const postApiV2Documents = (client: HttpClient, data: PostApiV2DocumentsPayload, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesDocument, APIV2EntitiesApiError>({
+    path: `/api/v2/documents`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags documents
+ * @name GetApiV2Documents
+ * @summary List all documents
+ * @request GET:/api/v2/documents
+ */
+export const getApiV2Documents = (client: HttpClient, query: GetApiV2DocumentsParams, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesDocument[], APIV2EntitiesApiError>({
+    path: `/api/v2/documents`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags documents
+ * @name DeleteApiV2DocumentsId
+ * @summary Destroy an document
+ * @request DELETE:/api/v2/documents/{id}
+ */
+export const deleteApiV2DocumentsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesDocument, APIV2EntitiesApiError>({
+    path: `/api/v2/documents/${id}`,
+    method: "DELETE",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags documents
+ * @name GetApiV2DocumentsId
+ * @summary Retrieve a document
+ * @request GET:/api/v2/documents/{id}
+ */
+export const getApiV2DocumentsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesDocument, APIV2EntitiesApiError>({
+    path: `/api/v2/documents/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};