@whiplashmerch/whiplash-api-client 0.0.1

package/generated/v2/index.ts

@@ -0,0 +1,20 @@
+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 './Scancodes';
+export * from './ShipnoticeItems';
+export * from './Shipnotices';
+export * from './Simulate';
+export * from './Templates';
+export * from './data-contracts';

package/generated/v2.1/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 { APIV21EntitiesApiError, APIV21EntitiesBundleItem, PutApiV21BundleItemsIdPayload } from "./data-contracts";
+
+/**
+ * @description This removes the item from the bundle, but does not affect the item in any other way.
+ *
+ * @tags items
+ * @name DeleteApiV21BundleItemsId
+ * @summary Destroy a bundle item
+ * @request DELETE:/api/v2.1/bundle_items/{id}
+ */
+export const deleteApiV21BundleItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/bundle_items/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name PutApiV21BundleItemsId
+ * @summary Update a bundle item's quantity
+ * @request PUT:/api/v2.1/bundle_items/{id}
+ */
+export const putApiV21BundleItemsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21BundleItemsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/bundle_items/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV21BundleItemsId
+ * @summary Retrieve a bundle item
+ * @request GET:/api/v2.1/bundle_items/{id}
+ */
+export const getApiV21BundleItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesBundleItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/bundle_items/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/ConsumerReturns.ts

@@ -0,0 +1,267 @@
+/* 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 {
+  APIV21EntitiesApiError,
+  APIV21EntitiesConsumerReturn,
+  APIV21EntitiesCount,
+  APIV21EntitiesMetaFields,
+  APIV21EntitiesPostResponse,
+  APIV21EntitiesResult,
+  GetApiV21ConsumerReturnsCountParams,
+  GetApiV21ConsumerReturnsIdMetaFieldsPayload,
+  GetApiV21ConsumerReturnsParams,
+  PostApiV21ConsumerReturnsBulkPayload,
+  PostApiV21ConsumerReturnsPayload,
+  PutApiV21ConsumerReturnsIdPayload,
+  PutApiV21ConsumerReturnsOriginatorOriginatorIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags originators
+ * @name DeleteApiV21ConsumerReturnsOriginatorOriginatorId
+ * @summary Destroy a consumer return
+ * @request DELETE:/api/v2.1/consumer_returns/originator/{originator_id}
+ */
+export const deleteApiV21ConsumerReturnsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns/originator/${originatorId}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name PutApiV21ConsumerReturnsOriginatorOriginatorId
+ * @summary Update a consumer return
+ * @request PUT:/api/v2.1/consumer_returns/originator/{originator_id}
+ */
+export const putApiV21ConsumerReturnsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  data: PutApiV21ConsumerReturnsOriginatorOriginatorIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns/originator/${originatorId}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21ConsumerReturnsOriginatorOriginatorId
+ * @summary Retrieve a consumer return
+ * @request GET:/api/v2.1/consumer_returns/originator/{originator_id}
+ */
+export const getApiV21ConsumerReturnsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesConsumerReturn, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns/originator/${originatorId}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags consumer_returns
+ * @name PutApiV21ConsumerReturnsIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/consumer_returns/{id}/meta_fields
+ */
+export const putApiV21ConsumerReturnsIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags consumer_returns
+ * @name GetApiV21ConsumerReturnsIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/consumer_returns/{id}/meta_fields
+ */
+export const getApiV21ConsumerReturnsIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV21ConsumerReturnsIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesMetaFields, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name DeleteApiV21ConsumerReturnsId
+ * @summary Destroy a consumer return
+ * @request DELETE:/api/v2.1/consumer_returns/{id}
+ */
+export const deleteApiV21ConsumerReturnsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name PutApiV21ConsumerReturnsId
+ * @summary Update a consumer return
+ * @request PUT:/api/v2.1/consumer_returns/{id}
+ */
+export const putApiV21ConsumerReturnsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21ConsumerReturnsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name GetApiV21ConsumerReturnsId
+ * @summary Retrieve a consumer return
+ * @request GET:/api/v2.1/consumer_returns/{id}
+ */
+export const getApiV21ConsumerReturnsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesConsumerReturn, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name PostApiV21ConsumerReturns
+ * @summary Create a consumer return
+ * @request POST:/api/v2.1/consumer_returns
+ */
+export const postApiV21ConsumerReturns = (
+  client: HttpClient,
+  data: PostApiV21ConsumerReturnsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesPostResponse, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name GetApiV21ConsumerReturns
+ * @summary List all consumer returns
+ * @request GET:/api/v2.1/consumer_returns
+ */
+export const getApiV21ConsumerReturns = (
+  client: HttpClient,
+  query: GetApiV21ConsumerReturnsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesConsumerReturn[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags consumer_returns
+ * @name GetApiV21ConsumerReturnsCount
+ * @summary Count consumer returns
+ * @request GET:/api/v2.1/consumer_returns/count
+ */
+export const getApiV21ConsumerReturnsCount = (
+  client: HttpClient,
+  query: GetApiV21ConsumerReturnsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/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 PostApiV21ConsumerReturnsBulk
+ * @summary Create consumer_returns in bulk
+ * @request POST:/api/v2.1/consumer_returns/bulk
+ */
+export const postApiV21ConsumerReturnsBulk = (
+  client: HttpClient,
+  data: PostApiV21ConsumerReturnsBulkPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesResult, APIV21EntitiesApiError>({
+    path: `/api/v2.1/consumer_returns/bulk`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/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 {
+  APIV21EntitiesApiError,
+  APIV21EntitiesCount,
+  APIV21EntitiesCustomer,
+  GetApiV21CustomersCountParams,
+  GetApiV21CustomersParams,
+  PutApiV21CustomersIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags customers
+ * @name GetApiV21CustomersCount
+ * @summary Count customers
+ * @request GET:/api/v2.1/customers/count
+ */
+export const getApiV21CustomersCount = (
+  client: HttpClient,
+  query: GetApiV21CustomersCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/customers/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags customers
+ * @name GetApiV21Customers
+ * @summary List all customers
+ * @request GET:/api/v2.1/customers
+ */
+export const getApiV21Customers = (client: HttpClient, query: GetApiV21CustomersParams, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesCustomer[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/customers`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get resource actions
+ *
+ * @tags customers
+ * @name GetApiV21CustomersActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/customers/actions
+ */
+export const getApiV21CustomersActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/customers/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * @description Update your customers' information and preferences
+ *
+ * @tags customers
+ * @name PutApiV21CustomersId
+ * @summary Update a customer
+ * @request PUT:/api/v2.1/customers/{id}
+ */
+export const putApiV21CustomersId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21CustomersIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCustomer, APIV21EntitiesApiError>({
+    path: `/api/v2.1/customers/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags customers
+ * @name GetApiV21CustomersId
+ * @summary Retrieve a customer
+ * @request GET:/api/v2.1/customers/{id}
+ */
+export const getApiV21CustomersId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesCustomer, APIV21EntitiesApiError>({
+    path: `/api/v2.1/customers/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/Documents.ts

@@ -0,0 +1,90 @@
+/* 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 {
+  APIV21EntitiesApiError,
+  APIV21EntitiesDocument,
+  GetApiV21DocumentsParams,
+  PostApiV21DocumentsPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags documents
+ * @name PostApiV21Documents
+ * @summary Create a document
+ * @request POST:/api/v2.1/documents
+ */
+export const postApiV21Documents = (
+  client: HttpClient,
+  data: PostApiV21DocumentsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesDocument, APIV21EntitiesApiError>({
+    path: `/api/v2.1/documents`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags documents
+ * @name GetApiV21Documents
+ * @summary List all documents
+ * @request GET:/api/v2.1/documents
+ */
+export const getApiV21Documents = (client: HttpClient, query: GetApiV21DocumentsParams, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesDocument[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/documents`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags documents
+ * @name DeleteApiV21DocumentsId
+ * @summary Destroy an document
+ * @request DELETE:/api/v2.1/documents/{id}
+ */
+export const deleteApiV21DocumentsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesDocument, APIV21EntitiesApiError>({
+    path: `/api/v2.1/documents/${id}`,
+    method: "DELETE",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags documents
+ * @name GetApiV21DocumentsId
+ * @summary Retrieve a document
+ * @request GET:/api/v2.1/documents/{id}
+ */
+export const getApiV21DocumentsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesDocument, APIV21EntitiesApiError>({
+    path: `/api/v2.1/documents/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};