@digital8/scope-backend-ts-sdk 0.0.1

package/dist/models/index.js

@@ -0,0 +1,266 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./AccountCodeType"), exports);
+__exportStar(require("./ActionItemRelationshipType"), exports);
+__exportStar(require("./ActionItemResource"), exports);
+__exportStar(require("./ActionItemResourceArrayResponse"), exports);
+__exportStar(require("./ActionItemStatus"), exports);
+__exportStar(require("./ActionItemType"), exports);
+__exportStar(require("./AddressResource"), exports);
+__exportStar(require("./AddressResourceArrayResponse"), exports);
+__exportStar(require("./AppointmentResource"), exports);
+__exportStar(require("./AppointmentResourceArrayResponse"), exports);
+__exportStar(require("./AssetFileForUploadResource"), exports);
+__exportStar(require("./AssetFileForUploadResourceArrayResponse"), exports);
+__exportStar(require("./AssetLiteResource"), exports);
+__exportStar(require("./AssetLiteResourceArrayResponse"), exports);
+__exportStar(require("./AssetResource"), exports);
+__exportStar(require("./AssetResourceArrayResponse"), exports);
+__exportStar(require("./AttachmentForCopyResource"), exports);
+__exportStar(require("./AttachmentForCopyResourceArrayResponse"), exports);
+__exportStar(require("./AttachmentRelationshipType"), exports);
+__exportStar(require("./AttachmentResource"), exports);
+__exportStar(require("./AttachmentResourceArrayResponse"), exports);
+__exportStar(require("./AustralianState"), exports);
+__exportStar(require("./BulkCopyAttachmentsRequest"), exports);
+__exportStar(require("./BulkDeleteAttachmentsRequest"), exports);
+__exportStar(require("./BusinessResource"), exports);
+__exportStar(require("./BusinessResourceArrayResponse"), exports);
+__exportStar(require("./BusinessUnitRelationResource"), exports);
+__exportStar(require("./BusinessUnitRelationResourceArrayResponse"), exports);
+__exportStar(require("./BusinessUnitResource"), exports);
+__exportStar(require("./BusinessUnitResourceArrayResponse"), exports);
+__exportStar(require("./CloneReportTemplateRequest"), exports);
+__exportStar(require("./ContactRelationResource"), exports);
+__exportStar(require("./ContactRelationResourceArrayResponse"), exports);
+__exportStar(require("./ContactResource"), exports);
+__exportStar(require("./ContactResourceArrayResponse"), exports);
+__exportStar(require("./ContactType"), exports);
+__exportStar(require("./CopyAttachmentRequest"), exports);
+__exportStar(require("./CreateActionItemRequest"), exports);
+__exportStar(require("./CreateAppointmentRequest"), exports);
+__exportStar(require("./CreateAttachmentRequest"), exports);
+__exportStar(require("./CreateBusinessUnitRequest"), exports);
+__exportStar(require("./CreateContactRequest"), exports);
+__exportStar(require("./CreateHeadInvoiceRequest"), exports);
+__exportStar(require("./CreateJobActivityRequest"), exports);
+__exportStar(require("./CreateJobCategoryRequest"), exports);
+__exportStar(require("./CreateJobNoteRequest"), exports);
+__exportStar(require("./CreateJobRequest"), exports);
+__exportStar(require("./CreateJobTypeRequest"), exports);
+__exportStar(require("./CreateKPIRequest"), exports);
+__exportStar(require("./CreateLicenceRequest"), exports);
+__exportStar(require("./CreateLineItemCategoryRequest"), exports);
+__exportStar(require("./CreateLineItemRequest"), exports);
+__exportStar(require("./CreateNoteRequest"), exports);
+__exportStar(require("./CreatePaymentRequest"), exports);
+__exportStar(require("./CreatePurchaseOrderRequest"), exports);
+__exportStar(require("./CreatePurchaseOrderRequestLineItemsInner"), exports);
+__exportStar(require("./CreateQuoteRequest"), exports);
+__exportStar(require("./CreateReportFieldGroupingRequest"), exports);
+__exportStar(require("./CreateReportFieldRequest"), exports);
+__exportStar(require("./CreateReportFieldRequestValuesInner"), exports);
+__exportStar(require("./CreateReportRequest"), exports);
+__exportStar(require("./CreateReportRequestAnswersInner"), exports);
+__exportStar(require("./CreateReportTemplateRequest"), exports);
+__exportStar(require("./CreateServiceProviderRequest"), exports);
+__exportStar(require("./CreateTeamRequest"), exports);
+__exportStar(require("./CreateTradeInvoiceRequest"), exports);
+__exportStar(require("./CreateUserRequest"), exports);
+__exportStar(require("./GenericResponse"), exports);
+__exportStar(require("./GetAttachmentsForCopyRequest"), exports);
+__exportStar(require("./GetConfigRequest"), exports);
+__exportStar(require("./GetDateForPaymentTermsRequest"), exports);
+__exportStar(require("./GetLicencesRequest"), exports);
+__exportStar(require("./GetUsersForTeamsRequest"), exports);
+__exportStar(require("./HeadInvoiceResource"), exports);
+__exportStar(require("./HeadInvoiceResourceArrayResponse"), exports);
+__exportStar(require("./HeadInvoiceStatus"), exports);
+__exportStar(require("./ImportInventoryRequest"), exports);
+__exportStar(require("./ItemsInner"), exports);
+__exportStar(require("./ItemsInner1"), exports);
+__exportStar(require("./JobActivityResource"), exports);
+__exportStar(require("./JobActivityResourceArrayResponse"), exports);
+__exportStar(require("./JobCategoryResource"), exports);
+__exportStar(require("./JobCategoryResourceArrayResponse"), exports);
+__exportStar(require("./JobContactResource"), exports);
+__exportStar(require("./JobContactResourceArrayResponse"), exports);
+__exportStar(require("./JobContactType"), exports);
+__exportStar(require("./JobDetailsResource"), exports);
+__exportStar(require("./JobDetailsResourceArrayResponse"), exports);
+__exportStar(require("./JobListResource"), exports);
+__exportStar(require("./JobListResourceArrayResponse"), exports);
+__exportStar(require("./JobNoteResource"), exports);
+__exportStar(require("./JobNoteResourceArrayResponse"), exports);
+__exportStar(require("./JobStatus"), exports);
+__exportStar(require("./JobStatusCode"), exports);
+__exportStar(require("./JobSubStatus"), exports);
+__exportStar(require("./JobSubStatusCode"), exports);
+__exportStar(require("./JobType"), exports);
+__exportStar(require("./JobTypeExternalType"), exports);
+__exportStar(require("./JobTypeResource"), exports);
+__exportStar(require("./JobTypeResourceArrayResponse"), exports);
+__exportStar(require("./KPIRelationshipType"), exports);
+__exportStar(require("./KPIReportingFilterRequest"), exports);
+__exportStar(require("./KPIReportingResource"), exports);
+__exportStar(require("./KPIReportingResourceArrayResponse"), exports);
+__exportStar(require("./KPIResource"), exports);
+__exportStar(require("./KPIResourceArrayResponse"), exports);
+__exportStar(require("./KPIType"), exports);
+__exportStar(require("./LicenceRelationshipType"), exports);
+__exportStar(require("./LicenceResource"), exports);
+__exportStar(require("./LicenceResourceArrayResponse"), exports);
+__exportStar(require("./LicenceType"), exports);
+__exportStar(require("./LightJobDetailsResource"), exports);
+__exportStar(require("./LightJobDetailsResourceArrayResponse"), exports);
+__exportStar(require("./LineItemCategoryLiteResource"), exports);
+__exportStar(require("./LineItemCategoryLiteResourceArrayResponse"), exports);
+__exportStar(require("./LineItemCategoryRelationshipType"), exports);
+__exportStar(require("./LineItemCategoryResource"), exports);
+__exportStar(require("./LineItemCategoryResourceArrayResponse"), exports);
+__exportStar(require("./LineItemLiteResource"), exports);
+__exportStar(require("./LineItemLiteResourceArrayResponse"), exports);
+__exportStar(require("./LineItemMeasurements"), exports);
+__exportStar(require("./LineItemRelationshipType"), exports);
+__exportStar(require("./LineItemResource"), exports);
+__exportStar(require("./LineItemResourceArrayResponse"), exports);
+__exportStar(require("./LoginRequest"), exports);
+__exportStar(require("./NoteRelationshipType"), exports);
+__exportStar(require("./NoteResource"), exports);
+__exportStar(require("./NoteResourceArrayResponse"), exports);
+__exportStar(require("./PaginatedActionItemResourceResponse"), exports);
+__exportStar(require("./PaginatedAttachmentForCopyResourceResponse"), exports);
+__exportStar(require("./PaginatedAttachmentResourceResponse"), exports);
+__exportStar(require("./PaginatedContactResourceResponse"), exports);
+__exportStar(require("./PaginatedHeadInvoiceResourceResponse"), exports);
+__exportStar(require("./PaginatedJobActivityResourceResponse"), exports);
+__exportStar(require("./PaginatedJobCategoryResourceResponse"), exports);
+__exportStar(require("./PaginatedJobListResourceResponse"), exports);
+__exportStar(require("./PaginatedJobNoteResourceResponse"), exports);
+__exportStar(require("./PaginatedJobTypeResourceResponse"), exports);
+__exportStar(require("./PaginatedPurchaseOrderResourceResponse"), exports);
+__exportStar(require("./PaginatedQuoteResourceResponse"), exports);
+__exportStar(require("./PaginatedReportFieldGroupingResourceResponse"), exports);
+__exportStar(require("./PaginatedReportResourceResponse"), exports);
+__exportStar(require("./PaginatedReportTemplateResourceResponse"), exports);
+__exportStar(require("./PaginatedServiceProviderResourceResponse"), exports);
+__exportStar(require("./PaginatedTradeInvoiceResourceResponse"), exports);
+__exportStar(require("./PaginatedUserResourceResponse"), exports);
+__exportStar(require("./PaginationRequest"), exports);
+__exportStar(require("./PagingMetadata"), exports);
+__exportStar(require("./PaymentResource"), exports);
+__exportStar(require("./PaymentResourceArrayResponse"), exports);
+__exportStar(require("./PaymentTerm"), exports);
+__exportStar(require("./PostponeActionItemRequest"), exports);
+__exportStar(require("./PurchaseOrderResource"), exports);
+__exportStar(require("./PurchaseOrderResourceArrayResponse"), exports);
+__exportStar(require("./PurchaseOrderStatus"), exports);
+__exportStar(require("./QuoteResource"), exports);
+__exportStar(require("./QuoteResourceArrayResponse"), exports);
+__exportStar(require("./QuoteStatus"), exports);
+__exportStar(require("./ReorderReportFieldGroupingsRequest"), exports);
+__exportStar(require("./ReorderReportFieldsRequest"), exports);
+__exportStar(require("./ReportAnswerResource"), exports);
+__exportStar(require("./ReportAnswerResourceArrayResponse"), exports);
+__exportStar(require("./ReportFieldGroupingResource"), exports);
+__exportStar(require("./ReportFieldGroupingResourceArrayResponse"), exports);
+__exportStar(require("./ReportFieldResource"), exports);
+__exportStar(require("./ReportFieldResourceArrayResponse"), exports);
+__exportStar(require("./ReportFieldType"), exports);
+__exportStar(require("./ReportFieldValueResource"), exports);
+__exportStar(require("./ReportFieldValueResourceArrayResponse"), exports);
+__exportStar(require("./ReportResource"), exports);
+__exportStar(require("./ReportResourceArrayResponse"), exports);
+__exportStar(require("./ReportStatus"), exports);
+__exportStar(require("./ReportTemplateResource"), exports);
+__exportStar(require("./ReportTemplateResourceArrayResponse"), exports);
+__exportStar(require("./ReportType"), exports);
+__exportStar(require("./ResetPasswordRequest"), exports);
+__exportStar(require("./ReviewResource"), exports);
+__exportStar(require("./ReviewResourceArrayResponse"), exports);
+__exportStar(require("./ReviewStatus"), exports);
+__exportStar(require("./SearchAccountCodesRequest"), exports);
+__exportStar(require("./SearchActionItemsRequest"), exports);
+__exportStar(require("./SearchAppointmentRequest"), exports);
+__exportStar(require("./SearchAttachmentsRequest"), exports);
+__exportStar(require("./SearchContactsRequest"), exports);
+__exportStar(require("./SearchHeadInvoiceRequest"), exports);
+__exportStar(require("./SearchInventoryRequest"), exports);
+__exportStar(require("./SearchJobCategoriesRequest"), exports);
+__exportStar(require("./SearchJobNoteRequest"), exports);
+__exportStar(require("./SearchJobTypesRequest"), exports);
+__exportStar(require("./SearchJobsRequest"), exports);
+__exportStar(require("./SearchKPIsRequest"), exports);
+__exportStar(require("./SearchPaymentRequest"), exports);
+__exportStar(require("./SearchPurchaseOrderRequest"), exports);
+__exportStar(require("./SearchQuotesRequest"), exports);
+__exportStar(require("./SearchReportTemplatesRequest"), exports);
+__exportStar(require("./SearchReportsRequest"), exports);
+__exportStar(require("./SearchServiceProvidersRequest"), exports);
+__exportStar(require("./SearchTeamsRequest"), exports);
+__exportStar(require("./SearchTradeInvoiceRequest"), exports);
+__exportStar(require("./SearchUsersRequest"), exports);
+__exportStar(require("./SendForgotPasswordLinkRequest"), exports);
+__exportStar(require("./ServiceProviderResource"), exports);
+__exportStar(require("./ServiceProviderResourceArrayResponse"), exports);
+__exportStar(require("./ServiceProviderType"), exports);
+__exportStar(require("./StaticImageUploadUrlRequest"), exports);
+__exportStar(require("./TeamResource"), exports);
+__exportStar(require("./TeamResourceArrayResponse"), exports);
+__exportStar(require("./TradeInvoiceResource"), exports);
+__exportStar(require("./TradeInvoiceResourceArrayResponse"), exports);
+__exportStar(require("./TradeInvoiceStatus"), exports);
+__exportStar(require("./UpdateActionItemRequest"), exports);
+__exportStar(require("./UpdateAppointmentRequest"), exports);
+__exportStar(require("./UpdateAttachmentRequest"), exports);
+__exportStar(require("./UpdateBusinessRequest"), exports);
+__exportStar(require("./UpdateBusinessUnitRequest"), exports);
+__exportStar(require("./UpdateContactRequest"), exports);
+__exportStar(require("./UpdateHeadInvoiceRequest"), exports);
+__exportStar(require("./UpdateJobActivityRequest"), exports);
+__exportStar(require("./UpdateJobCategoryRequest"), exports);
+__exportStar(require("./UpdateJobNoteRequest"), exports);
+__exportStar(require("./UpdateJobRequest"), exports);
+__exportStar(require("./UpdateJobRequestContactsInner"), exports);
+__exportStar(require("./UpdateKPIRequest"), exports);
+__exportStar(require("./UpdateLicenceRequest"), exports);
+__exportStar(require("./UpdateLineItemCategoryRequest"), exports);
+__exportStar(require("./UpdateLineItemRequest"), exports);
+__exportStar(require("./UpdateNoteRequest"), exports);
+__exportStar(require("./UpdatePurchaseOrderRequest"), exports);
+__exportStar(require("./UpdatePurchaseOrderRequestLineItemsInner"), exports);
+__exportStar(require("./UpdateQuoteRequest"), exports);
+__exportStar(require("./UpdateReportFieldGroupingRequest"), exports);
+__exportStar(require("./UpdateReportFieldRequest"), exports);
+__exportStar(require("./UpdateReportFieldRequestValuesInner"), exports);
+__exportStar(require("./UpdateReportRequest"), exports);
+__exportStar(require("./UpdateReportRequestAnswersInner"), exports);
+__exportStar(require("./UpdateReportTemplateRequest"), exports);
+__exportStar(require("./UpdateServiceProviderRequest"), exports);
+__exportStar(require("./UpdateStaticImageRequest"), exports);
+__exportStar(require("./UpdateTeamRequest"), exports);
+__exportStar(require("./UpdateTradeInvoiceRequest"), exports);
+__exportStar(require("./UpdateUserRequest"), exports);
+__exportStar(require("./UserRelationResource"), exports);
+__exportStar(require("./UserRelationResourceArrayResponse"), exports);
+__exportStar(require("./UserResource"), exports);
+__exportStar(require("./UserResourceArrayResponse"), exports);
+__exportStar(require("./UserRoleType"), exports);
+__exportStar(require("./XeroSyncModelType"), exports);
+__exportStar(require("./XeroSyncStatus"), exports);

package/dist/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * 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.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}