@whiplashmerch/whiplash-api-client 0.0.1

package/generated/v2.1/NotificationEvents.ts

@@ -0,0 +1,55 @@
+/* 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 {
+  APIV21EntitiesApiError,
+  APIV21EntitiesNotificationEvent,
+  GetApiV21NotificationEventsParams,
+} from "./data-contracts";
+
+/**
+ * @description There are a wide variety of events you may subscribe to, and we add new ones periodically. You can grab a complete list at any time.
+ *
+ * @tags notifications
+ * @name GetApiV21NotificationEvents
+ * @summary List all notification events
+ * @request GET:/api/v2.1/notification_events
+ */
+export const getApiV21NotificationEvents = (
+  client: HttpClient,
+  query: GetApiV21NotificationEventsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesNotificationEvent[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/notification_events`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags notifications
+ * @name GetApiV21NotificationEventsId
+ * @summary Retrieve a notification event
+ * @request GET:/api/v2.1/notification_events/{id}
+ */
+export const getApiV21NotificationEventsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesNotificationEvent, APIV21EntitiesApiError>({
+    path: `/api/v2.1/notification_events/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/NotificationSubscriptions.ts

@@ -0,0 +1,161 @@
+/* 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,
+  APIV21EntitiesNotificationSubscription,
+  GetApiV21NotificationSubscriptionsCountParams,
+  GetApiV21NotificationSubscriptionsParams,
+  PostApiV21NotificationSubscriptionsPayload,
+  PutApiV21NotificationSubscriptionsIdPayload,
+} from "./data-contracts";
+
+/**
+ * @description Subscribe to an e-mail, web hook, or sms notification for a specified event
+ *
+ * @tags notifications
+ * @name PostApiV21NotificationSubscriptions
+ * @summary Create a notification subscription
+ * @request POST:/api/v2.1/notification_subscriptions
+ */
+export const postApiV21NotificationSubscriptions = (
+  client: HttpClient,
+  data: PostApiV21NotificationSubscriptionsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesNotificationSubscription, APIV21EntitiesApiError>({
+    path: `/api/v2.1/notification_subscriptions`,
+    method: "POST",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description E-mail, web hook, and sms notifications you have subscribed to
+ *
+ * @tags notifications
+ * @name GetApiV21NotificationSubscriptions
+ * @summary List all notification subscriptions
+ * @request GET:/api/v2.1/notification_subscriptions
+ */
+export const getApiV21NotificationSubscriptions = (
+  client: HttpClient,
+  query: GetApiV21NotificationSubscriptionsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesNotificationSubscription[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/notification_subscriptions`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Get a count of notification subscriptions
+ *
+ * @tags notifications
+ * @name GetApiV21NotificationSubscriptionsCount
+ * @summary Count notification subscriptions
+ * @request GET:/api/v2.1/notification_subscriptions/count
+ */
+export const getApiV21NotificationSubscriptionsCount = (
+  client: HttpClient,
+  query: GetApiV21NotificationSubscriptionsCountParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesCount, APIV21EntitiesApiError>({
+    path: `/api/v2.1/notification_subscriptions/count`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Send yourself a test e-mail, web hook, or sms message
+ *
+ * @tags notifications
+ * @name GetApiV21NotificationSubscriptionsIdTest
+ * @summary Test a notification subscription
+ * @request GET:/api/v2.1/notification_subscriptions/{id}/test
+ */
+export const getApiV21NotificationSubscriptionsIdTest = (
+  client: HttpClient,
+  id: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesNotificationSubscription, APIV21EntitiesApiError>({
+    path: `/api/v2.1/notification_subscriptions/${id}/test`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags notifications
+ * @name DeleteApiV21NotificationSubscriptionsId
+ * @summary Delete a notification subscription
+ * @request DELETE:/api/v2.1/notification_subscriptions/{id}
+ */
+export const deleteApiV21NotificationSubscriptionsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesNotificationSubscription, APIV21EntitiesApiError>({
+    path: `/api/v2.1/notification_subscriptions/${id}`,
+    method: "DELETE",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags notifications
+ * @name PutApiV21NotificationSubscriptionsId
+ * @summary Update a notification subscription
+ * @request PUT:/api/v2.1/notification_subscriptions/{id}
+ */
+export const putApiV21NotificationSubscriptionsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21NotificationSubscriptionsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesNotificationSubscription, APIV21EntitiesApiError>({
+    path: `/api/v2.1/notification_subscriptions/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * No description
+ *
+ * @tags notifications
+ * @name GetApiV21NotificationSubscriptionsId
+ * @summary Retrieve a notification subscription
+ * @request GET:/api/v2.1/notification_subscriptions/{id}
+ */
+export const getApiV21NotificationSubscriptionsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesNotificationSubscription, APIV21EntitiesApiError>({
+    path: `/api/v2.1/notification_subscriptions/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/OrderDocuments.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 { APIV21EntitiesApiError, APIV21EntitiesOrderDocument } from "./data-contracts";
+
+/**
+ * @description Remove an order document from an order
+ *
+ * @tags orders
+ * @name DeleteApiV21OrderDocumentsId
+ * @summary Delete an order document
+ * @request DELETE:/api/v2.1/order_documents/{id}
+ */
+export const deleteApiV21OrderDocumentsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesOrderDocument, APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_documents/${id}`,
+    method: "DELETE",
+    format: "json",
+    ...params,
+  });
+};

package/generated/v2.1/OrderItems.ts

@@ -0,0 +1,189 @@
+/* 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,
+  APIV21EntitiesMetaFields,
+  APIV21EntitiesOrderItem,
+  APIV21EntitiesSerialNumber,
+  GetApiV21OrderItemsIdMetaFieldsPayload,
+  GetApiV21OrderItemsIdParams,
+  PutApiV21OrderItemsIdPayload,
+} from "./data-contracts";
+
+/**
+ * @description Get resource actions
+ *
+ * @tags order_items
+ * @name GetApiV21OrderItemsActions
+ * @summary List actions you can peform
+ * @request GET:/api/v2.1/order_items/actions
+ */
+export const getApiV21OrderItemsActions = (client: HttpClient, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_items/actions`,
+    method: "GET",
+    ...params,
+  });
+};
+/**
+ * @description Destroy an order item
+ *
+ * @tags order_items
+ * @name DeleteApiV21OrderItemsId
+ * @summary Destroy an order item
+ * @request DELETE:/api/v2.1/order_items/{id}
+ */
+export const deleteApiV21OrderItemsId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_items/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * @description Update an order item
+ *
+ * @tags order_items
+ * @name PutApiV21OrderItemsId
+ * @summary Update an order item
+ * @request PUT:/api/v2.1/order_items/{id}
+ */
+export const putApiV21OrderItemsId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21OrderItemsIdPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_items/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.FormData,
+    ...params,
+  });
+};
+/**
+ * @description Retrieve an order item
+ *
+ * @tags order_items
+ * @name GetApiV21OrderItemsId
+ * @summary Retrieve an order item
+ * @request GET:/api/v2.1/order_items/{id}
+ */
+export const getApiV21OrderItemsId = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21OrderItemsIdParams,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOrderItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_items/${id}`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update Shop meta fields
+ *
+ * @tags order_items
+ * @name PutApiV21OrderItemsIdMetaFields
+ * @summary Set meta fields
+ * @request PUT:/api/v2.1/order_items/{id}/meta_fields
+ */
+export const putApiV21OrderItemsIdMetaFields = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_items/${id}/meta_fields`,
+    method: "PUT",
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Get the meta fields for a(n) Shop
+ *
+ * @tags order_items
+ * @name GetApiV21OrderItemsIdMetaFields
+ * @summary List meta fields
+ * @request GET:/api/v2.1/order_items/{id}/meta_fields
+ */
+export const getApiV21OrderItemsIdMetaFields = (
+  client: HttpClient,
+  id: number,
+  data: GetApiV21OrderItemsIdMetaFieldsPayload,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesMetaFields, APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_items/${id}/meta_fields`,
+    method: "GET",
+    body: data,
+    type: ContentType.FormData,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Separate an order item into a new order
+ *
+ * @tags order_items
+ * @name PutApiV21OrderItemsIdSeparate
+ * @summary Separate an order item
+ * @request PUT:/api/v2.1/order_items/{id}/separate
+ */
+export const putApiV21OrderItemsIdSeparate = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesOrderItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_items/${id}/separate`,
+    method: "PUT",
+    type: ContentType.Json,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Perform an action on an order_item
+ *
+ * @tags order_items
+ * @name PutApiV21OrderItemsIdCallAction
+ * @summary Perform an action on an order_item
+ * @request PUT:/api/v2.1/order_items/{id}/call/{action}
+ */
+export const putApiV21OrderItemsIdCallAction = (
+  client: HttpClient,
+  id: number,
+  action: number,
+  params: RequestParams = {},
+) => {
+  return client.request<APIV21EntitiesOrderItem, APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_items/${id}/call/${action}`,
+    method: "PUT",
+    type: ContentType.Json,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Serial numbers are scanned and saved during the packing process.
+ *
+ * @tags order_items
+ * @name GetApiV21OrderItemsIdSerialNumbers
+ * @summary List all serial numbers associated with an order item
+ * @request GET:/api/v2.1/order_items/{id}/serial_numbers
+ */
+export const getApiV21OrderItemsIdSerialNumbers = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<APIV21EntitiesSerialNumber[], APIV21EntitiesApiError>({
+    path: `/api/v2.1/order_items/${id}/serial_numbers`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};