@whiplashmerch/whiplash-api-client 0.0.1

package/generated/v2/Orders.ts

@@ -0,0 +1,436 @@
+/* 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,
+  APIV2EntitiesMetaFields,
+  APIV2EntitiesOrder,
+  APIV2EntitiesOrderDocument,
+  APIV2EntitiesOrderEvent,
+  APIV2EntitiesOrderItem,
+  APIV2EntitiesResult,
+  APIV2EntitiesSerialNumber,
+  GetApiV2OrdersCountParams,
+  GetApiV2OrdersIdEventsCountParams,
+  GetApiV2OrdersIdEventsParams,
+  GetApiV2OrdersIdMetaFieldsPayload,
+  GetApiV2OrdersIdOrderDocumentsParams,
+  GetApiV2OrdersIdOrderItemsCountParams,
+  GetApiV2OrdersIdOrderItemsParams,
+  GetApiV2OrdersParams,
+  PostApiV2OrdersBulkPayload,
+  PostApiV2OrdersIdOrderDocumentsPayload,
+  PostApiV2OrdersIdOrderItemsPayload,
+  PostApiV2OrdersPayload,
+  PutApiV2OrdersIdPayload,
+  PutApiV2OrdersOriginatorOriginatorIdPayload,
+} from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags orders
+ * @name PostApiV2Orders
+ * @summary Create an order
+ * @request POST:/api/v2/orders
+ */
+export const postApiV2Orders = (client: HttpClient, data: PostApiV2OrdersPayload, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/orders`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV2Orders
+ * @summary List all orders
+ * @request GET:/api/v2/orders
+ */
+export const getApiV2Orders = (client: HttpClient, query: GetApiV2OrdersParams, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesOrder[], APIV2EntitiesApiError>({
+    path: `/api/v2/orders`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV2OrdersCount
+ * @summary Count orders
+ * @request GET:/api/v2/orders/count
+ */
+export const getApiV2OrdersCount = (
+  client: HttpClient,
+  query: GetApiV2OrdersCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/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 orders
+ * @name PostApiV2OrdersBulk
+ * @summary Create consumer_returns in bulk
+ * @request POST:/api/v2/orders/bulk
+ */
+export const postApiV2OrdersBulk = (
+  client: HttpClient,
+  data: PostApiV2OrdersBulkPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesResult, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/bulk`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get resource actions
+ *
+ * @tags orders
+ * @name GetApiV2OrdersActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2/orders/actions
+ */
+export const getApiV2OrdersActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name PutApiV2OrdersOriginatorOriginatorId
+ * @summary Update an order
+ * @request PUT:/api/v2/orders/originator/{originator_id}
+ */
+export const putApiV2OrdersOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  data: PutApiV2OrdersOriginatorOriginatorIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/originator/${originatorId}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV2OrdersOriginatorOriginatorId
+ * @summary Retrieve an order
+ * @request GET:/api/v2/orders/originator/{originator_id}
+ */
+export const getApiV2OrdersOriginatorOriginatorId = (
+  client: HttpClient,
+  originatorId: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesOrder, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/originator/${originatorId}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdEventsCount
+ * @summary Count order's events
+ * @request GET:/api/v2/orders/{id}/events/count
+ */
+export const getApiV2OrdersIdEventsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2OrdersIdEventsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/events/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdEvents
+ * @summary Retrieve the history for an order
+ * @request GET:/api/v2/orders/{id}/events
+ */
+export const getApiV2OrdersIdEvents = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2OrdersIdEventsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesOrderEvent[], APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/events`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name PutApiV2OrdersId
+ * @summary Update an order
+ * @request PUT:/api/v2/orders/{id}
+ */
+export const putApiV2OrdersId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV2OrdersIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV2OrdersId
+ * @summary Retrieve an order
+ * @request GET:/api/v2/orders/{id}
+ */
+export const getApiV2OrdersId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesOrder, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags orders
+ * @name PutApiV2OrdersIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2/orders/{id}/meta_fields
+ */
+export const putApiV2OrdersIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2/orders/{id}/meta_fields
+ */
+export const getApiV2OrdersIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV2OrdersIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesMetaFields, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description OrderDocuments are files attached to and order, like a pre-printed shipping label, BOL, etc.
+ *
+ * @tags orders
+ * @name PostApiV2OrdersIdOrderDocuments
+ * @summary Create an order document for an order
+ * @request POST:/api/v2/orders/{id}/order_documents
+ */
+export const postApiV2OrdersIdOrderDocuments = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV2OrdersIdOrderDocumentsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesOrderDocument, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/order_documents`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Retrieve all order documents for an order
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdOrderDocuments
+ * @summary List all order documents for an order
+ * @request GET:/api/v2/orders/{id}/order_documents
+ */
+export const getApiV2OrdersIdOrderDocuments = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2OrdersIdOrderDocumentsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesOrderDocument[], APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/order_documents`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Create an order item
+ *
+ * @tags orders
+ * @name PostApiV2OrdersIdOrderItems
+ * @summary Create an order item
+ * @request POST:/api/v2/orders/{id}/order_items
+ */
+export const postApiV2OrdersIdOrderItems = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV2OrdersIdOrderItemsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/order_items`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * @description Retrieve all order items for an order
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdOrderItems
+ * @summary List all order items for an order
+ * @request GET:/api/v2/orders/{id}/order_items
+ */
+export const getApiV2OrdersIdOrderItems = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2OrdersIdOrderItemsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesOrderItem[], APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/order_items`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdOrderItemsCount
+ * @summary Count order items
+ * @request GET:/api/v2/orders/{id}/order_items/count
+ */
+export const getApiV2OrdersIdOrderItemsCount = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2OrdersIdOrderItemsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesCount, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/order_items/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Actions can be performed UPON an order. They don't necessarily update the order itself. You can see which actions are available to you at /orders/actions
+ *
+ * @tags orders
+ * @name PutApiV2OrdersIdCallAction
+ * @summary Perform an action on an order
+ * @request PUT:/api/v2/orders/{id}/call/{action}
+ */
+export const putApiV2OrdersIdCallAction = (
+  client: HttpClient,
+  id: number,
+  action: number,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/call/${action}`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Serial numbers are scanned and saved during the packing process.
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdSerialNumbers
+ * @summary List all serial numbers associated with an order item
+ * @request GET:/api/v2/orders/{id}/serial_numbers
+ */
+export const getApiV2OrdersIdSerialNumbers = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesSerialNumber[], APIV2EntitiesApiError>({
+    path: `/api/v2/orders/${id}/serial_numbers`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2/Originators.ts

@@ -0,0 +1,35 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV2EntitiesApiError, APIV2EntitiesOriginator, GetApiV2OriginatorsParams } from "./data-contracts";
+
+/**
+ * No description
+ *
+ * @tags originators
+ * @name GetApiV2Originators
+ * @summary List originators
+ * @request GET:/api/v2/originators
+ */
+export const getApiV2Originators = (
+  client: HttpClient,
+  query: GetApiV2OriginatorsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesOriginator, APIV2EntitiesApiError>({
+    path: `/api/v2/originators`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2/Public.ts

@@ -0,0 +1,41 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { HttpClient, RequestParams } from "./../http-client";
+
+/**
+ * No description
+ *
+ * @tags public
+ * @name GetApiV2PublicStatus
+ * @request GET:/api/v2/public/status
+ */
+export const getApiV2PublicStatus = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, any>({
+    path: `/api/v2/public/status`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags public
+ * @name GetApiV2PublicCarrierStatus
+ * @request GET:/api/v2/public/carrier_status
+ */
+export const getApiV2PublicCarrierStatus = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, any>({
+    path: `/api/v2/public/carrier_status`,
+    method: "GET",
+    ...params,
+  });
+};

package/generated/v2/ScancodeAliases.ts

@@ -0,0 +1,34 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV2EntitiesApiError, APIV2EntitiesScancode, GetApiV2ScancodeAliasesParams } from "./data-contracts";
+
+/**
+ * @description Get all scancode_aliases
+ *
+ * @tags scancode_aliases
+ * @name GetApiV2ScancodeAliases
+ * @request GET:/api/v2/scancode_aliases
+ */
+export const getApiV2ScancodeAliases = (
+  client: HttpClient,
+  query: GetApiV2ScancodeAliasesParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV2EntitiesScancode[], APIV2EntitiesApiError>({
+    path: `/api/v2/scancode_aliases`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2/Scancodes.ts

@@ -0,0 +1,30 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { HttpClient, RequestParams } from "./../http-client";
+import { APIV2EntitiesApiError, APIV2EntitiesScancode, GetApiV2ScancodesParams } from "./data-contracts";
+
+/**
+ * @description Get all scancodes
+ *
+ * @tags scancodes
+ * @name GetApiV2Scancodes
+ * @request GET:/api/v2/scancodes
+ */
+export const getApiV2Scancodes = (client: HttpClient, query: GetApiV2ScancodesParams, params: RequestParams = {}) => {
+  return client.request<APIV2EntitiesScancode[], APIV2EntitiesApiError>({
+    path: `/api/v2/scancodes`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};