@whiplashmerch/whiplash-api-client 0.0.1

package/generated/v2.1/Items.ts

@@ -0,0 +1,563 @@
+/* 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,
+  APIV21EntitiesCount,
+  APIV21EntitiesItem,
+  APIV21EntitiesItemWarehouseQuantity,
+  APIV21EntitiesMetaFields,
+  APIV21EntitiesOriginator,
+  APIV21EntitiesPostResponse,
+  APIV21EntitiesScancodeAlias,
+  APIV21EntitiesShipnoticeItem,
+  APIV21EntitiesTransaction,
+  GetApiV21ItemsCountParams,
+  GetApiV21ItemsIdMetaFieldsPayload,
+  GetApiV21ItemsIdOriginatorsParams,
+  GetApiV21ItemsIdScancodeAliasesParams,
+  GetApiV21ItemsIdShipnoticeItemsCountParams,
+  GetApiV21ItemsIdShipnoticeItemsParams,
+  GetApiV21ItemsIdTransactionsCountParams,
+  GetApiV21ItemsIdTransactionsParams,
+  GetApiV21ItemsOriginatorOriginatorIdScancodeAliasesParams,
+  GetApiV21ItemsParams,
+  PostApiV21ItemsIdBundleItemsPayload,
+  PostApiV21ItemsPayload,
+  PutApiV21ItemsIdPayload,
+  PutApiV21ItemsOriginatorOriginatorIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags items
+ * @name PostApiV21Items
+ * @summary Create an item
+ * @request POST:/api/v2.1/items
+ */
+export const postApiV21Items = (client: HttpClient, data: PostApiV21ItemsPayload, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesPostResponse, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV21Items
+ * @summary List all items
+ * @request GET:/api/v2.1/items
+ */
+export const getApiV21Items = (client: HttpClient, query: GetApiV21ItemsParams, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesItem[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/items`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get resource actions
+ *
+ * @tags items
+ * @name GetApiV21ItemsActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/items/actions
+ */
+export const getApiV21ItemsActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * @description An item may have many alternate scancodes
+ *
+ * @tags originators
+ * @name GetApiV21ItemsOriginatorOriginatorIdScancodeAliases
+ * @summary List all scancodes associated with this item
+ * @request GET:/api/v2.1/items/originator/{originator_id}/scancode_aliases
+ */
+export const getApiV21ItemsOriginatorOriginatorIdScancodeAliases = (
+  client: HttpClient,
+  { originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdScancodeAliasesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesScancodeAlias[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/originator/${originatorId}/scancode_aliases`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
+ *
+ * @tags originators
+ * @name GetApiV21ItemsOriginatorOriginatorIdWarehouseQuantities
+ * @summary Item stock by warehouse
+ * @request GET:/api/v2.1/items/originator/{originator_id}/warehouse_quantities
+ */
+export const getApiV21ItemsOriginatorOriginatorIdWarehouseQuantities = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesItemWarehouseQuantity, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/originator/${originatorId}/warehouse_quantities`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21ItemsOriginatorOriginatorIdBundleItems
+ * @summary List all bundle items containing this item
+ * @request GET:/api/v2.1/items/originator/{originator_id}/bundle_items
+ */
+export const getApiV21ItemsOriginatorOriginatorIdBundleItems = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesBundleItem[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/originator/${originatorId}/bundle_items`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21ItemsOriginatorOriginatorIdInBundles
+ * @summary List all instances of this item in bundles
+ * @request GET:/api/v2.1/items/originator/{originator_id}/in_bundles
+ */
+export const getApiV21ItemsOriginatorOriginatorIdInBundles = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesItem[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/originator/${originatorId}/in_bundles`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
+ *
+ * @tags originators
+ * @name DeleteApiV21ItemsOriginatorOriginatorId
+ * @summary Archive an item
+ * @request DELETE:/api/v2.1/items/originator/{originator_id}
+ */
+export const deleteApiV21ItemsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/originator/${originatorId}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name PutApiV21ItemsOriginatorOriginatorId
+ * @summary Update an item
+ * @request PUT:/api/v2.1/items/originator/{originator_id}
+ */
+export const putApiV21ItemsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  data: PutApiV21ItemsOriginatorOriginatorIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/originator/${originatorId}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV21ItemsOriginatorOriginatorId
+ * @summary Retrieve an item
+ * @request GET:/api/v2.1/items/originator/{originator_id}
+ */
+export const getApiV21ItemsOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/originator/${originatorId}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags items
+ * @name PutApiV21ItemsIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/items/{id}/meta_fields
+ */
+export const putApiV21ItemsIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/items/{id}/meta_fields
+ */
+export const getApiV21ItemsIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV21ItemsIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesMetaFields, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description An item may have many alternate scancodes
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdScancodeAliases
+ * @summary List all scancodes associated with this item
+ * @request GET:/api/v2.1/items/{id}/scancode_aliases
+ */
+export const getApiV21ItemsIdScancodeAliases = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21ItemsIdScancodeAliasesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesScancodeAlias[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/scancode_aliases`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdWarehouseQuantities
+ * @summary Item stock by warehouse
+ * @request GET:/api/v2.1/items/{id}/warehouse_quantities
+ */
+export const getApiV21ItemsIdWarehouseQuantities = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesItemWarehouseQuantity, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/warehouse_quantities`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdBundleItems
+ * @summary List all bundle items containing this item
+ * @request GET:/api/v2.1/items/{id}/bundle_items
+ */
+export const getApiV21ItemsIdBundleItems = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesBundleItem[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/bundle_items`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description A Bundle is an Item representing a set of Items to be grouped and shipped together. Creating Product Bundles is useful when you sell a set of items, but you also sell the items individually. Creating a bundle allows us to keep the inventory flexible so we can ship the constituent items as they are sold individually, or as a set. In most cases, it's simplest to use Whiplash bundles as a replacement for your e-commerce platform's bundle feature / plugin.
+ *
+ * @tags items
+ * @name PostApiV21ItemsIdBundleItems
+ * @summary Add an item to an bundle
+ * @request POST:/api/v2.1/items/{id}/bundle_items
+ */
+export const postApiV21ItemsIdBundleItems = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV21ItemsIdBundleItemsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesPostResponse, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/bundle_items`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdInBundles
+ * @summary List all instances of this item in bundles
+ * @request GET:/api/v2.1/items/{id}/in_bundles
+ */
+export const getApiV21ItemsIdInBundles = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesItem[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/in_bundles`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
+ *
+ * @tags items
+ * @name DeleteApiV21ItemsId
+ * @summary Archive an item
+ * @request DELETE:/api/v2.1/items/{id}
+ */
+export const deleteApiV21ItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name PutApiV21ItemsId
+ * @summary Update an item
+ * @request PUT:/api/v2.1/items/{id}
+ */
+export const putApiV21ItemsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21ItemsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV21ItemsId
+ * @summary Retrieve an item
+ * @request GET:/api/v2.1/items/{id}
+ */
+export const getApiV21ItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdOriginators
+ * @summary List associated originators
+ * @request GET:/api/v2.1/items/{id}/originators
+ */
+export const getApiV21ItemsIdOriginators = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21ItemsIdOriginatorsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOriginator, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/originators`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV21ItemsCount
+ * @summary Count items
+ * @request GET:/api/v2.1/items/count
+ */
+export const getApiV21ItemsCount = (
+  client: HttpClient,
+  query: GetApiV21ItemsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Actions can be performed UPON an item. They don't necessarily update the item itself. You can see which actions are available to you at /items/actions
+ *
+ * @tags items
+ * @name PutApiV21ItemsIdCallAction
+ * @summary Perform an action on an item
+ * @request PUT:/api/v2.1/items/{id}/call/{action}
+ */
+export const putApiV21ItemsIdCallAction = (
+  client: HttpClient,
+  id: number,
+  action: number,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/call/${action}`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdShipnoticeItemsCount
+ * @summary Count associated ship notice items
+ * @request GET:/api/v2.1/items/{id}/shipnotice_items/count
+ */
+export const getApiV21ItemsIdShipnoticeItemsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21ItemsIdShipnoticeItemsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/shipnotice_items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdShipnoticeItems
+ * @summary List associated ship notice items
+ * @request GET:/api/v2.1/items/{id}/shipnotice_items
+ */
+export const getApiV21ItemsIdShipnoticeItems = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21ItemsIdShipnoticeItemsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesShipnoticeItem[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/shipnotice_items`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Returns count of item transactions
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdTransactionsCount
+ * @summary Count the transactions in an item's history
+ * @request GET:/api/v2.1/items/{id}/transactions/count
+ */
+export const getApiV21ItemsIdTransactionsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21ItemsIdTransactionsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/transactions/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get all transactions for an item
+ *
+ * @tags items
+ * @name GetApiV21ItemsIdTransactions
+ * @summary List an item's history
+ * @request GET:/api/v2.1/items/{id}/transactions
+ */
+export const getApiV21ItemsIdTransactions = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21ItemsIdTransactionsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesTransaction[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/items/${id}/transactions`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/MetaKeys.ts

@@ -0,0 +1,132 @@
+/* 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,
+  APIV21EntitiesMetaKey,
+  APIV21EntitiesPostResponse,
+  GetApiV21MetaKeysCountParams,
+  GetApiV21MetaKeysParams,
+  PostApiV21MetaKeysPayload,
+  PutApiV21MetaKeysIdPayload,
+} from "./data-contracts";
+
+/**
+ * @description Create a meta_key
+ *
+ * @tags meta_keys
+ * @name PostApiV21MetaKeys
+ * @summary Create a meta_key
+ * @request POST:/api/v2.1/meta_keys
+ */
+export const postApiV21MetaKeys = (client: HttpClient, data: PostApiV21MetaKeysPayload, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesPostResponse, APIV21EntitiesApiError>({
+    path: `/api/v2.1/meta_keys`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get a list of meta_keys
+ *
+ * @tags meta_keys
+ * @name GetApiV21MetaKeys
+ * @summary List all meta keys
+ * @request GET:/api/v2.1/meta_keys
+ */
+export const getApiV21MetaKeys = (client: HttpClient, query: GetApiV21MetaKeysParams, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesMetaKey[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/meta_keys`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Returns count of meta_keys
+ *
+ * @tags meta_keys
+ * @name GetApiV21MetaKeysCount
+ * @summary Count meta keys
+ * @request GET:/api/v2.1/meta_keys/count
+ */
+export const getApiV21MetaKeysCount = (
+  client: HttpClient,
+  query: GetApiV21MetaKeysCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/meta_keys/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Destroy a meta_key
+ *
+ * @tags meta_keys
+ * @name DeleteApiV21MetaKeysId
+ * @summary Delete a meta_key
+ * @request DELETE:/api/v2.1/meta_keys/{id}
+ */
+export const deleteApiV21MetaKeysId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/meta_keys/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * @description Update a meta_key
+ *
+ * @tags meta_keys
+ * @name PutApiV21MetaKeysId
+ * @summary Update a meta_key
+ * @request PUT:/api/v2.1/meta_keys/{id}
+ */
+export const putApiV21MetaKeysId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21MetaKeysIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/meta_keys/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * @description Get a meta_key
+ *
+ * @tags meta_keys
+ * @name GetApiV21MetaKeysId
+ * @summary Retrieve a meta key
+ * @request GET:/api/v2.1/meta_keys/{id}
+ */
+export const getApiV21MetaKeysId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesMetaKey, APIV21EntitiesApiError>({
+    path: `/api/v2.1/meta_keys/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};