@digital8/lighting-illusions-ts-sdk 0.0.2523 → 0.0.2524

package/src/apis/ReturnsApi.ts

@@ -0,0 +1,381 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  AttachReturnAssetsRequest,
+  CreateReturnRequest,
+  GenericResponse,
+  PaginatedReturnListResourceResponse,
+  ReturnLiteResourceArrayResponse,
+  ReturnResource,
+  SearchReturnsRequest,
+  UpdateReturnRequest,
+} from '../models/index';
+import {
+    AttachReturnAssetsRequestFromJSON,
+    AttachReturnAssetsRequestToJSON,
+    CreateReturnRequestFromJSON,
+    CreateReturnRequestToJSON,
+    GenericResponseFromJSON,
+    GenericResponseToJSON,
+    PaginatedReturnListResourceResponseFromJSON,
+    PaginatedReturnListResourceResponseToJSON,
+    ReturnLiteResourceArrayResponseFromJSON,
+    ReturnLiteResourceArrayResponseToJSON,
+    ReturnResourceFromJSON,
+    ReturnResourceToJSON,
+    SearchReturnsRequestFromJSON,
+    SearchReturnsRequestToJSON,
+    UpdateReturnRequestFromJSON,
+    UpdateReturnRequestToJSON,
+} from '../models/index';
+
+export interface AttachAssetsReturnRequest {
+    productReturn: number;
+    attachReturnAssetsRequest?: AttachReturnAssetsRequest;
+}
+
+export interface DestroyReturnRequest {
+    productReturn: number;
+}
+
+export interface DetachAssetReturnRequest {
+    productReturn: number;
+    asset: number;
+}
+
+export interface GetAllReturnRequest {
+    searchReturnsRequest?: SearchReturnsRequest;
+}
+
+export interface IndexReturnRequest {
+    searchReturnsRequest?: SearchReturnsRequest;
+}
+
+export interface ShowReturnRequest {
+    productReturn: number;
+}
+
+export interface StoreReturnRequest {
+    createReturnRequest?: CreateReturnRequest;
+}
+
+export interface UpdateReturnOperationRequest {
+    productReturn: number;
+    updateReturnRequest?: UpdateReturnRequest;
+}
+
+/**
+ * 
+ */
+export class ReturnsApi extends runtime.BaseAPI {
+
+    /**
+     * Auto-generated: attachAssetsReturn
+     */
+    async attachAssetsReturnRaw(requestParameters: AttachAssetsReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReturnResource>> {
+        if (requestParameters['productReturn'] == null) {
+            throw new runtime.RequiredError(
+                'productReturn',
+                'Required parameter "productReturn" was null or undefined when calling attachAssetsReturn().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/returns/{productReturn}/assets/attach`;
+        urlPath = urlPath.replace(`{${"productReturn"}}`, encodeURIComponent(String(requestParameters['productReturn'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AttachReturnAssetsRequestToJSON(requestParameters['attachReturnAssetsRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReturnResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: attachAssetsReturn
+     */
+    async attachAssetsReturn(requestParameters: AttachAssetsReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReturnResource> {
+        const response = await this.attachAssetsReturnRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: destroyReturn
+     */
+    async destroyReturnRaw(requestParameters: DestroyReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        if (requestParameters['productReturn'] == null) {
+            throw new runtime.RequiredError(
+                'productReturn',
+                'Required parameter "productReturn" was null or undefined when calling destroyReturn().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/returns/{productReturn}/delete`;
+        urlPath = urlPath.replace(`{${"productReturn"}}`, encodeURIComponent(String(requestParameters['productReturn'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: destroyReturn
+     */
+    async destroyReturn(requestParameters: DestroyReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.destroyReturnRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: detachAssetReturn
+     */
+    async detachAssetReturnRaw(requestParameters: DetachAssetReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReturnResource>> {
+        if (requestParameters['productReturn'] == null) {
+            throw new runtime.RequiredError(
+                'productReturn',
+                'Required parameter "productReturn" was null or undefined when calling detachAssetReturn().'
+            );
+        }
+
+        if (requestParameters['asset'] == null) {
+            throw new runtime.RequiredError(
+                'asset',
+                'Required parameter "asset" was null or undefined when calling detachAssetReturn().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/returns/{productReturn}/assets/{asset}/detach`;
+        urlPath = urlPath.replace(`{${"productReturn"}}`, encodeURIComponent(String(requestParameters['productReturn'])));
+        urlPath = urlPath.replace(`{${"asset"}}`, encodeURIComponent(String(requestParameters['asset'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReturnResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: detachAssetReturn
+     */
+    async detachAssetReturn(requestParameters: DetachAssetReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReturnResource> {
+        const response = await this.detachAssetReturnRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: getAllReturn
+     */
+    async getAllReturnRaw(requestParameters: GetAllReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReturnLiteResourceArrayResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/returns/all`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SearchReturnsRequestToJSON(requestParameters['searchReturnsRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReturnLiteResourceArrayResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: getAllReturn
+     */
+    async getAllReturn(requestParameters: GetAllReturnRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReturnLiteResourceArrayResponse> {
+        const response = await this.getAllReturnRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: indexReturn
+     */
+    async indexReturnRaw(requestParameters: IndexReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedReturnListResourceResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/returns/list`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SearchReturnsRequestToJSON(requestParameters['searchReturnsRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedReturnListResourceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: indexReturn
+     */
+    async indexReturn(requestParameters: IndexReturnRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedReturnListResourceResponse> {
+        const response = await this.indexReturnRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: showReturn
+     */
+    async showReturnRaw(requestParameters: ShowReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReturnResource>> {
+        if (requestParameters['productReturn'] == null) {
+            throw new runtime.RequiredError(
+                'productReturn',
+                'Required parameter "productReturn" was null or undefined when calling showReturn().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/returns/{productReturn}`;
+        urlPath = urlPath.replace(`{${"productReturn"}}`, encodeURIComponent(String(requestParameters['productReturn'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReturnResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: showReturn
+     */
+    async showReturn(requestParameters: ShowReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReturnResource> {
+        const response = await this.showReturnRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: storeReturn
+     */
+    async storeReturnRaw(requestParameters: StoreReturnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReturnResource>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/returns/create`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateReturnRequestToJSON(requestParameters['createReturnRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReturnResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: storeReturn
+     */
+    async storeReturn(requestParameters: StoreReturnRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReturnResource> {
+        const response = await this.storeReturnRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Auto-generated: updateReturn
+     */
+    async updateReturnRaw(requestParameters: UpdateReturnOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReturnResource>> {
+        if (requestParameters['productReturn'] == null) {
+            throw new runtime.RequiredError(
+                'productReturn',
+                'Required parameter "productReturn" was null or undefined when calling updateReturn().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/returns/{productReturn}/update`;
+        urlPath = urlPath.replace(`{${"productReturn"}}`, encodeURIComponent(String(requestParameters['productReturn'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateReturnRequestToJSON(requestParameters['updateReturnRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReturnResourceFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: updateReturn
+     */
+    async updateReturn(requestParameters: UpdateReturnOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReturnResource> {
+        const response = await this.updateReturnRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -30,6 +30,7 @@ export * from './ProductRangeApi';
 export * from './ProductRegistrationApi';
 export * from './ProductTypeApi';
 export * from './RedirectApi';
+export * from './ReturnsApi';
 export * from './ReviewApi';
 export * from './RolesApi';
 export * from './SiteApi';

package/src/models/AddressFrontendResource.ts

@@ -42,7 +42,7 @@ export interface AddressFrontendResource {
      * @type {string}
      * @memberof AddressFrontendResource
      */
-    company?: string | null;
+    company: string;
     /**
      * 
      * @type {string}
@@ -92,6 +92,7 @@ export interface AddressFrontendResource {
  */
 export function instanceOfAddressFrontendResource(value: object): value is AddressFrontendResource {
     if (!('addresseeName' in value) || value['addresseeName'] === undefined) return false;
+    if (!('company' in value) || value['company'] === undefined) return false;
     if (!('line1' in value) || value['line1'] === undefined) return false;
     if (!('postcode' in value) || value['postcode'] === undefined) return false;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
@@ -114,7 +115,7 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
         'id': json['id'] == null ? undefined : json['id'],
         'type': json['type'] == null ? undefined : json['type'],
         'addresseeName': json['addresseeName'],
-        'company': json['company'] == null ? undefined : json['company'],
+        'company': json['company'],
         'line1': json['line1'],
         'line2': json['line2'] == null ? undefined : json['line2'],
         'postcode': json['postcode'],

package/src/models/AddressResource.ts

@@ -42,13 +42,13 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    addresseeName: string;
+    addresseeName?: string | null;
     /**
      * 
      * @type {string}
      * @memberof AddressResource
      */
-    company: string;
+    company?: string | null;
     /**
      * 
      * @type {string}
@@ -97,8 +97,6 @@ export interface AddressResource {
  * Check if a given object implements the AddressResource interface.
  */
 export function instanceOfAddressResource(value: object): value is AddressResource {
-    if (!('addresseeName' in value) || value['addresseeName'] === undefined) return false;
-    if (!('company' in value) || value['company'] === undefined) return false;
     if (!('line1' in value) || value['line1'] === undefined) return false;
     if (!('line2' in value) || value['line2'] === undefined) return false;
     if (!('postcode' in value) || value['postcode'] === undefined) return false;
@@ -122,8 +120,8 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         'id': json['id'] == null ? undefined : json['id'],
         'type': json['type'] == null ? undefined : json['type'],
         'sourceAddressId': json['sourceAddressId'] == null ? undefined : json['sourceAddressId'],
-        'addresseeName': json['addresseeName'],
-        'company': json['company'],
+        'addresseeName': json['addresseeName'] == null ? undefined : json['addresseeName'],
+        'company': json['company'] == null ? undefined : json['company'],
         'line1': json['line1'],
         'line2': json['line2'],
         'postcode': json['postcode'],

package/src/models/AttachReturnAssetsRequest.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface AttachReturnAssetsRequest
+ */
+export interface AttachReturnAssetsRequest {
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof AttachReturnAssetsRequest
+     */
+    assetIds: Array<number>;
+}
+
+/**
+ * Check if a given object implements the AttachReturnAssetsRequest interface.
+ */
+export function instanceOfAttachReturnAssetsRequest(value: object): value is AttachReturnAssetsRequest {
+    if (!('assetIds' in value) || value['assetIds'] === undefined) return false;
+    return true;
+}
+
+export function AttachReturnAssetsRequestFromJSON(json: any): AttachReturnAssetsRequest {
+    return AttachReturnAssetsRequestFromJSONTyped(json, false);
+}
+
+export function AttachReturnAssetsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AttachReturnAssetsRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'assetIds': json['asset_ids'],
+    };
+}
+
+export function AttachReturnAssetsRequestToJSON(json: any): AttachReturnAssetsRequest {
+    return AttachReturnAssetsRequestToJSONTyped(json, false);
+}
+
+export function AttachReturnAssetsRequestToJSONTyped(value?: AttachReturnAssetsRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'asset_ids': value['assetIds'],
+    };
+}
+

package/src/models/CreateReturnRequest.ts

@@ -0,0 +1,164 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * My API
+ * API documentation for my Laravel app
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateReturnRequest
+ */
+export interface CreateReturnRequest {
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateReturnRequest
+     */
+    lineItemId: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateReturnRequest
+     */
+    reviewerId?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateReturnRequest
+     */
+    quantity: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReturnRequest
+     */
+    status: CreateReturnRequestStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReturnRequest
+     */
+    reason: CreateReturnRequestReasonEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReturnRequest
+     */
+    returnMethod: CreateReturnRequestReturnMethodEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReturnRequest
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReturnRequest
+     */
+    netsuiteId?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const CreateReturnRequestStatusEnum = {
+    PendingApproval: 'pending_approval',
+    Complete: 'complete',
+    Cancelled: 'cancelled',
+    Rejected: 'rejected',
+    Approved: 'approved'
+} as const;
+export type CreateReturnRequestStatusEnum = typeof CreateReturnRequestStatusEnum[keyof typeof CreateReturnRequestStatusEnum];
+
+/**
+ * @export
+ */
+export const CreateReturnRequestReasonEnum = {
+    ChangeOfMind: 'change_of_mind',
+    OrderedMoreThanRequired: 'ordered_more_than_required',
+    OrderedIncorrectProduct: 'ordered_incorrect_product',
+    IncorrectProductReceived: 'incorrect_product_received',
+    DamagedInTransit: 'damaged_in_transit',
+    FaultyProduct: 'faulty_product',
+    Other: 'other'
+} as const;
+export type CreateReturnRequestReasonEnum = typeof CreateReturnRequestReasonEnum[keyof typeof CreateReturnRequestReasonEnum];
+
+/**
+ * @export
+ */
+export const CreateReturnRequestReturnMethodEnum = {
+    ShipItBack: 'ship_it_back',
+    DropAtWarehouse: 'drop_at_warehouse'
+} as const;
+export type CreateReturnRequestReturnMethodEnum = typeof CreateReturnRequestReturnMethodEnum[keyof typeof CreateReturnRequestReturnMethodEnum];
+
+
+/**
+ * Check if a given object implements the CreateReturnRequest interface.
+ */
+export function instanceOfCreateReturnRequest(value: object): value is CreateReturnRequest {
+    if (!('lineItemId' in value) || value['lineItemId'] === undefined) return false;
+    if (!('quantity' in value) || value['quantity'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    if (!('returnMethod' in value) || value['returnMethod'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    return true;
+}
+
+export function CreateReturnRequestFromJSON(json: any): CreateReturnRequest {
+    return CreateReturnRequestFromJSONTyped(json, false);
+}
+
+export function CreateReturnRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateReturnRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'lineItemId': json['line_item_id'],
+        'reviewerId': json['reviewer_id'] == null ? undefined : json['reviewer_id'],
+        'quantity': json['quantity'],
+        'status': json['status'],
+        'reason': json['reason'],
+        'returnMethod': json['return_method'],
+        'description': json['description'],
+        'netsuiteId': json['netsuite_id'] == null ? undefined : json['netsuite_id'],
+    };
+}
+
+export function CreateReturnRequestToJSON(json: any): CreateReturnRequest {
+    return CreateReturnRequestToJSONTyped(json, false);
+}
+
+export function CreateReturnRequestToJSONTyped(value?: CreateReturnRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'line_item_id': value['lineItemId'],
+        'reviewer_id': value['reviewerId'],
+        'quantity': value['quantity'],
+        'status': value['status'],
+        'reason': value['reason'],
+        'return_method': value['returnMethod'],
+        'description': value['description'],
+        'netsuite_id': value['netsuiteId'],
+    };
+}
+