swoop-common 1.0.21 → 1.0.23

package/dist/api/generated/swoop/services/SwoopService.d.ts

@@ -0,0 +1,387 @@
+import type { BookingItemType_jsonld } from '../models/BookingItemType_jsonld';
+import type { Category_jsonld } from '../models/Category_jsonld';
+import type { Currency_jsonld } from '../models/Currency_jsonld';
+import type { Customer_jsonld } from '../models/Customer_jsonld';
+import type { CustomerLookup_jsonld } from '../models/CustomerLookup_jsonld';
+import type { Enquiry_jsonld } from '../models/Enquiry_jsonld';
+import type { EnquiryStatus_jsonld } from '../models/EnquiryStatus_jsonld';
+import type { Partner_jsonld } from '../models/Partner_jsonld';
+import type { Payment_jsonld } from '../models/Payment_jsonld';
+import type { Person_jsonld } from '../models/Person_jsonld';
+import type { Traveller_jsonld } from '../models/Traveller_jsonld';
+import type { Trip_jsonld } from '../models/Trip_jsonld';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class SwoopService {
+    /**
+     * Retrieves the collection of BookingItemType resources.
+     * Retrieves the collection of BookingItemType resources.
+     * @param region antarctica, arctic, patagonia
+     * @param active 1,0
+     * @returns any BookingItemType collection
+     * @throws ApiError
+     */
+    bookingItemTypesGetCollection(region?: string, active?: string): CancelablePromise<{
+        member: Array<BookingItemType_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves the collection of Category resources.
+     * Retrieves the collection of Category resources.
+     * @param region antarctica, arctic, patagonia
+     * @param active 1,0
+     * @returns any Category collection
+     * @throws ApiError
+     */
+    categoriesGetCollection(region?: string, active?: string): CancelablePromise<{
+        member: Array<Category_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves the collection of Currency resources.
+     * Retrieves the collection of Currency resources.
+     * @param region antarctica, arctic, patagonia
+     * @param active 1,0
+     * @returns any Currency collection
+     * @throws ApiError
+     */
+    currenciesGetCollection(region?: string, active?: string): CancelablePromise<{
+        member: Array<Currency_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves the collection of Customer resources.
+     * Retrieves the collection of Customer resources.
+     * @param page The collection page number
+     * @param itemsPerPage The number of items per page
+     * @param search Search against first_name, last_name, email
+     * @param region antarctica, arctic, patagonia
+     * @returns any Customer collection
+     * @throws ApiError
+     */
+    customersGetCollection(page?: number, itemsPerPage?: number, search?: string, region?: string): CancelablePromise<{
+        member: Array<Customer_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves a Customer resource.
+     * Retrieves a Customer resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{customer_id}})
+     * @returns Customer_jsonld Customer resource
+     * @throws ApiError
+     */
+    customersIdGet(id: string): CancelablePromise<Customer_jsonld>;
+    /**
+     * Retrieves a CustomerLookup resource.
+     * Retrieves a CustomerLookup resource.
+     * @param telephone Customer telephone number to look up (+447877887878)
+     * @param region antarctica, arctic, patagonia
+     * @returns CustomerLookup_jsonld CustomerLookup resource
+     * @throws ApiError
+     */
+    customersLookUpGet(telephone?: string, region?: string): CancelablePromise<CustomerLookup_jsonld>;
+    /**
+     * Retrieves a Enquiry resource.
+     * Retrieves a Enquiry resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{enquiry_id}})
+     * @returns Enquiry_jsonld Enquiry resource
+     * @throws ApiError
+     */
+    enquiryIdGet(id: string): CancelablePromise<Enquiry_jsonld>;
+    /**
+     * Retrieves the collection of EnquiryStatus resources.
+     * Retrieves the collection of EnquiryStatus resources.
+     * @param region antarctica, arctic, patagonia
+     * @returns any EnquiryStatus collection
+     * @throws ApiError
+     */
+    enquiryStatusesGetCollection(region?: string): CancelablePromise<{
+        member: Array<EnquiryStatus_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves the collection of Partner resources.
+     * Retrieves the collection of Partner resources.
+     * @param page The collection page number
+     * @param itemsPerPage The number of items per page
+     * @param region antarctica, arctic, patagonia
+     * @param search Search against title, alias, description, name, telephone, email
+     * @param active Filter by active status (0,1)
+     * @returns any Partner collection
+     * @throws ApiError
+     */
+    partnersGetCollection(page?: number, itemsPerPage?: number, region?: string, search?: string, active?: string): CancelablePromise<{
+        member: Array<Partner_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves a Partner resource.
+     * Retrieves a Partner resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{partner_id}})
+     * @returns Partner_jsonld Partner resource
+     * @throws ApiError
+     */
+    partnersIdGet(id: string): CancelablePromise<Partner_jsonld>;
+    /**
+     * Retrieves the collection of Payment resources.
+     * Retrieves the collection of Payment resources.
+     * @param enquiryId by enquiry ID
+     * @returns any Payment collection
+     * @throws ApiError
+     */
+    paymentsGetCollection(enquiryId?: string): CancelablePromise<{
+        member: Array<Payment_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves the collection of Person resources.
+     * Retrieves the collection of Person resources.
+     * @param region antarctica, arctic, patagonia
+     * @returns any Person collection
+     * @throws ApiError
+     */
+    peopleGetCollection(region?: string): CancelablePromise<{
+        member: Array<Person_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves a Person resource.
+     * Retrieves a Person resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{person_id}})
+     * @returns Person_jsonld Person resource
+     * @throws ApiError
+     */
+    peopleIdGet(id: string): CancelablePromise<Person_jsonld>;
+    /**
+     * Retrieves the collection of Traveller resources.
+     * Retrieves the collection of Traveller resources.
+     * @param enquiryId by enquiry ID
+     * @param region antarctica, arctic, patagonia
+     * @returns any Traveller collection
+     * @throws ApiError
+     */
+    travellersGetCollection(enquiryId?: string, region?: string): CancelablePromise<{
+        member: Array<Traveller_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves a Traveller resource.
+     * Retrieves a Traveller resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{traveller_id}})
+     * @returns Traveller_jsonld Traveller resource
+     * @throws ApiError
+     */
+    travellersIdGet(id: string): CancelablePromise<Traveller_jsonld>;
+    /**
+     * Retrieves the collection of Trip resources.
+     * Retrieves the collection of Trip resources.
+     * @param page The collection page number
+     * @param itemsPerPage The number of items per page
+     * @param search Search against title
+     * @param region antarctica, arctic, patagonia
+     * @param publishstate unpublished, approval, published, rejected
+     * @returns any Trip collection
+     * @throws ApiError
+     */
+    tripsGetCollection(page?: number, itemsPerPage?: number, search?: string, region?: string, publishstate?: string): CancelablePromise<{
+        member: Array<Trip_jsonld>;
+        totalItems?: number;
+        view?: {
+            '@id'?: string;
+            '@type'?: string;
+            first?: string;
+            last?: string;
+            previous?: string;
+            next?: string;
+        };
+        search?: {
+            '@type'?: string;
+            template?: string;
+            variableRepresentation?: string;
+            mapping?: Array<{
+                '@type'?: string;
+                variable?: string;
+                property?: string | null;
+                required?: boolean;
+            }>;
+        };
+    }>;
+    /**
+     * Retrieves a Trip resource.
+     * Retrieves a Trip resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{trip_id}})
+     * @returns Trip_jsonld Trip resource
+     * @throws ApiError
+     */
+    tripsIdGet(id: string): CancelablePromise<Trip_jsonld>;
+}

package/dist/api/generated/swoop/services/SwoopService.js

@@ -0,0 +1,329 @@
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class SwoopService {
+    /**
+     * Retrieves the collection of BookingItemType resources.
+     * Retrieves the collection of BookingItemType resources.
+     * @param region antarctica, arctic, patagonia
+     * @param active 1,0
+     * @returns any BookingItemType collection
+     * @throws ApiError
+     */
+    bookingItemTypesGetCollection(region, active) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/booking-item-types',
+            query: {
+                'region': region,
+                'active': active,
+            },
+        });
+    }
+    /**
+     * Retrieves the collection of Category resources.
+     * Retrieves the collection of Category resources.
+     * @param region antarctica, arctic, patagonia
+     * @param active 1,0
+     * @returns any Category collection
+     * @throws ApiError
+     */
+    categoriesGetCollection(region, active) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/categories',
+            query: {
+                'region': region,
+                'active': active,
+            },
+        });
+    }
+    /**
+     * Retrieves the collection of Currency resources.
+     * Retrieves the collection of Currency resources.
+     * @param region antarctica, arctic, patagonia
+     * @param active 1,0
+     * @returns any Currency collection
+     * @throws ApiError
+     */
+    currenciesGetCollection(region, active) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/currencies',
+            query: {
+                'region': region,
+                'active': active,
+            },
+        });
+    }
+    /**
+     * Retrieves the collection of Customer resources.
+     * Retrieves the collection of Customer resources.
+     * @param page The collection page number
+     * @param itemsPerPage The number of items per page
+     * @param search Search against first_name, last_name, email
+     * @param region antarctica, arctic, patagonia
+     * @returns any Customer collection
+     * @throws ApiError
+     */
+    customersGetCollection(page = 1, itemsPerPage = 30, search, region) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/customers',
+            query: {
+                'page': page,
+                'itemsPerPage': itemsPerPage,
+                'search': search,
+                'region': region,
+            },
+        });
+    }
+    /**
+     * Retrieves a Customer resource.
+     * Retrieves a Customer resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{customer_id}})
+     * @returns Customer_jsonld Customer resource
+     * @throws ApiError
+     */
+    customersIdGet(id) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/customers/{id}',
+            path: {
+                'id': id,
+            },
+            errors: {
+                404: `Not found`,
+            },
+        });
+    }
+    /**
+     * Retrieves a CustomerLookup resource.
+     * Retrieves a CustomerLookup resource.
+     * @param telephone Customer telephone number to look up (+447877887878)
+     * @param region antarctica, arctic, patagonia
+     * @returns CustomerLookup_jsonld CustomerLookup resource
+     * @throws ApiError
+     */
+    customersLookUpGet(telephone, region) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/customers-look-up',
+            query: {
+                'telephone': telephone,
+                'region': region,
+            },
+            errors: {
+                404: `Not found`,
+            },
+        });
+    }
+    /**
+     * Retrieves a Enquiry resource.
+     * Retrieves a Enquiry resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{enquiry_id}})
+     * @returns Enquiry_jsonld Enquiry resource
+     * @throws ApiError
+     */
+    enquiryIdGet(id) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/enquiry/{id}',
+            path: {
+                'id': id,
+            },
+            errors: {
+                404: `Not found`,
+            },
+        });
+    }
+    /**
+     * Retrieves the collection of EnquiryStatus resources.
+     * Retrieves the collection of EnquiryStatus resources.
+     * @param region antarctica, arctic, patagonia
+     * @returns any EnquiryStatus collection
+     * @throws ApiError
+     */
+    enquiryStatusesGetCollection(region) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/enquiry-statuses',
+            query: {
+                'region': region,
+            },
+        });
+    }
+    /**
+     * Retrieves the collection of Partner resources.
+     * Retrieves the collection of Partner resources.
+     * @param page The collection page number
+     * @param itemsPerPage The number of items per page
+     * @param region antarctica, arctic, patagonia
+     * @param search Search against title, alias, description, name, telephone, email
+     * @param active Filter by active status (0,1)
+     * @returns any Partner collection
+     * @throws ApiError
+     */
+    partnersGetCollection(page = 1, itemsPerPage = 30, region, search, active) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/partners',
+            query: {
+                'page': page,
+                'itemsPerPage': itemsPerPage,
+                'region': region,
+                'search': search,
+                'active': active,
+            },
+        });
+    }
+    /**
+     * Retrieves a Partner resource.
+     * Retrieves a Partner resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{partner_id}})
+     * @returns Partner_jsonld Partner resource
+     * @throws ApiError
+     */
+    partnersIdGet(id) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/partners/{id}',
+            path: {
+                'id': id,
+            },
+            errors: {
+                404: `Not found`,
+            },
+        });
+    }
+    /**
+     * Retrieves the collection of Payment resources.
+     * Retrieves the collection of Payment resources.
+     * @param enquiryId by enquiry ID
+     * @returns any Payment collection
+     * @throws ApiError
+     */
+    paymentsGetCollection(enquiryId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/payments',
+            query: {
+                'enquiry_id': enquiryId,
+            },
+        });
+    }
+    /**
+     * Retrieves the collection of Person resources.
+     * Retrieves the collection of Person resources.
+     * @param region antarctica, arctic, patagonia
+     * @returns any Person collection
+     * @throws ApiError
+     */
+    peopleGetCollection(region) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/people',
+            query: {
+                'region': region,
+            },
+        });
+    }
+    /**
+     * Retrieves a Person resource.
+     * Retrieves a Person resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{person_id}})
+     * @returns Person_jsonld Person resource
+     * @throws ApiError
+     */
+    peopleIdGet(id) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/people/{id}',
+            path: {
+                'id': id,
+            },
+            errors: {
+                404: `Not found`,
+            },
+        });
+    }
+    /**
+     * Retrieves the collection of Traveller resources.
+     * Retrieves the collection of Traveller resources.
+     * @param enquiryId by enquiry ID
+     * @param region antarctica, arctic, patagonia
+     * @returns any Traveller collection
+     * @throws ApiError
+     */
+    travellersGetCollection(enquiryId, region) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/travellers',
+            query: {
+                'enquiry_id': enquiryId,
+                'region': region,
+            },
+        });
+    }
+    /**
+     * Retrieves a Traveller resource.
+     * Retrieves a Traveller resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{traveller_id}})
+     * @returns Traveller_jsonld Traveller resource
+     * @throws ApiError
+     */
+    travellersIdGet(id) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/travellers/{id}',
+            path: {
+                'id': id,
+            },
+            errors: {
+                404: `Not found`,
+            },
+        });
+    }
+    /**
+     * Retrieves the collection of Trip resources.
+     * Retrieves the collection of Trip resources.
+     * @param page The collection page number
+     * @param itemsPerPage The number of items per page
+     * @param search Search against title
+     * @param region antarctica, arctic, patagonia
+     * @param publishstate unpublished, approval, published, rejected
+     * @returns any Trip collection
+     * @throws ApiError
+     */
+    tripsGetCollection(page = 1, itemsPerPage = 30, search, region, publishstate) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/trips',
+            query: {
+                'page': page,
+                'itemsPerPage': itemsPerPage,
+                'search': search,
+                'region': region,
+                'publishstate': publishstate,
+            },
+        });
+    }
+    /**
+     * Retrieves a Trip resource.
+     * Retrieves a Trip resource.
+     * @param id The unique identifier example: ANT-12345 ({REGION}-{trip_id}})
+     * @returns Trip_jsonld Trip resource
+     * @throws ApiError
+     */
+    tripsIdGet(id) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/trips/{id}',
+            path: {
+                'id': id,
+            },
+            errors: {
+                404: `Not found`,
+            },
+        });
+    }
+}