@equisoft/ucx-proxy-sdk-typescript 0.0.3-snapshot.20250910185730

package/src/apis/OrganizationSourceAuthenticationApi.ts

@@ -0,0 +1,332 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UCX Proxy
+ * A single use API for the UCX Proxy.
+ *
+ * The version of the OpenAPI document: 0.0.3-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * 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 {
+  CreatePayloadSourceAuthenticationSchema,
+  ErrorSchema,
+  ListOrganizationSourceAuthenticationResultSchema,
+  OrganizationSourceAuthenticationResultSchema,
+  ToggleSourceAuthenticationSchema,
+  UpdatePayloadSourceAuthenticationSchema,
+} from '../models/index';
+import {
+    CreatePayloadSourceAuthenticationSchemaFromJSON,
+    CreatePayloadSourceAuthenticationSchemaToJSON,
+    ErrorSchemaFromJSON,
+    ErrorSchemaToJSON,
+    ListOrganizationSourceAuthenticationResultSchemaFromJSON,
+    ListOrganizationSourceAuthenticationResultSchemaToJSON,
+    OrganizationSourceAuthenticationResultSchemaFromJSON,
+    OrganizationSourceAuthenticationResultSchemaToJSON,
+    ToggleSourceAuthenticationSchemaFromJSON,
+    ToggleSourceAuthenticationSchemaToJSON,
+    UpdatePayloadSourceAuthenticationSchemaFromJSON,
+    UpdatePayloadSourceAuthenticationSchemaToJSON,
+} from '../models/index';
+
+export interface CreateOrganizationSourceRequest {
+    organizationId: string;
+    payload: CreatePayloadSourceAuthenticationSchema;
+    certificate?: Blob | null;
+}
+
+export interface DeleteOrganizationSourceRequest {
+    organizationId: string;
+    sourceKey: string;
+}
+
+export interface ListOrganizationSourcesRequest {
+    organizationId: string;
+}
+
+export interface ToggleOrganizationSourceRequest {
+    organizationId: string;
+    sourceKey: string;
+    toggleSourceAuthenticationSchema: ToggleSourceAuthenticationSchema;
+}
+
+export interface UpdateOrganizationSourceRequest {
+    organizationId: string;
+    sourceKey: string;
+    payload: UpdatePayloadSourceAuthenticationSchema;
+    certificate?: Blob | null;
+}
+
+/**
+ * 
+ */
+export class OrganizationSourceAuthenticationApi extends runtime.BaseAPI {
+
+    /**
+     * Create a new source for an organization and authenticate
+     */
+    async createOrganizationSourceRaw(requestParameters: CreateOrganizationSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrganizationSourceAuthenticationResultSchema>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling createOrganizationSource().'
+            );
+        }
+
+        if (requestParameters['payload'] == null) {
+            throw new runtime.RequiredError(
+                'payload',
+                'Required parameter "payload" was null or undefined when calling createOrganizationSource().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['payload'] != null) {
+            formParams.append('payload', new Blob([JSON.stringify(OrganizationSourceAuthenticationResultSchemaToJSON(requestParameters['payload']))], { type: "application/json", }));
+                    }
+
+        if (requestParameters['certificate'] != null) {
+            formParams.append('certificate', requestParameters['certificate'] as any);
+        }
+
+        const response = await this.request({
+            path: `/authentications/organizations/{organizationId}/sources`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrganizationSourceAuthenticationResultSchemaFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new source for an organization and authenticate
+     */
+    async createOrganizationSource(requestParameters: CreateOrganizationSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrganizationSourceAuthenticationResultSchema> {
+        const response = await this.createOrganizationSourceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete an existing source
+     */
+    async deleteOrganizationSourceRaw(requestParameters: DeleteOrganizationSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling deleteOrganizationSource().'
+            );
+        }
+
+        if (requestParameters['sourceKey'] == null) {
+            throw new runtime.RequiredError(
+                'sourceKey',
+                'Required parameter "sourceKey" was null or undefined when calling deleteOrganizationSource().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/authentications/organizations/{organizationId}/sources/{sourceKey}`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))).replace(`{${"sourceKey"}}`, encodeURIComponent(String(requestParameters['sourceKey']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete an existing source
+     */
+    async deleteOrganizationSource(requestParameters: DeleteOrganizationSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteOrganizationSourceRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get all the authentication sources for an organization
+     */
+    async listOrganizationSourcesRaw(requestParameters: ListOrganizationSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrganizationSourceAuthenticationResultSchema>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling listOrganizationSources().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/authentications/organizations/{organizationId}/sources`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListOrganizationSourceAuthenticationResultSchemaFromJSON(jsonValue));
+    }
+
+    /**
+     * Get all the authentication sources for an organization
+     */
+    async listOrganizationSources(requestParameters: ListOrganizationSourcesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrganizationSourceAuthenticationResultSchema> {
+        const response = await this.listOrganizationSourcesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Enable or disable a given source for an organization
+     */
+    async toggleOrganizationSourceRaw(requestParameters: ToggleOrganizationSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrganizationSourceAuthenticationResultSchema>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling toggleOrganizationSource().'
+            );
+        }
+
+        if (requestParameters['sourceKey'] == null) {
+            throw new runtime.RequiredError(
+                'sourceKey',
+                'Required parameter "sourceKey" was null or undefined when calling toggleOrganizationSource().'
+            );
+        }
+
+        if (requestParameters['toggleSourceAuthenticationSchema'] == null) {
+            throw new runtime.RequiredError(
+                'toggleSourceAuthenticationSchema',
+                'Required parameter "toggleSourceAuthenticationSchema" was null or undefined when calling toggleOrganizationSource().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/authentications/organizations/{organizationId}/sources/{sourceKey}/state`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))).replace(`{${"sourceKey"}}`, encodeURIComponent(String(requestParameters['sourceKey']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ToggleSourceAuthenticationSchemaToJSON(requestParameters['toggleSourceAuthenticationSchema']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrganizationSourceAuthenticationResultSchemaFromJSON(jsonValue));
+    }
+
+    /**
+     * Enable or disable a given source for an organization
+     */
+    async toggleOrganizationSource(requestParameters: ToggleOrganizationSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrganizationSourceAuthenticationResultSchema> {
+        const response = await this.toggleOrganizationSourceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update the credentials of a given source for an organization
+     */
+    async updateOrganizationSourceRaw(requestParameters: UpdateOrganizationSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrganizationSourceAuthenticationResultSchema>> {
+        if (requestParameters['organizationId'] == null) {
+            throw new runtime.RequiredError(
+                'organizationId',
+                'Required parameter "organizationId" was null or undefined when calling updateOrganizationSource().'
+            );
+        }
+
+        if (requestParameters['sourceKey'] == null) {
+            throw new runtime.RequiredError(
+                'sourceKey',
+                'Required parameter "sourceKey" was null or undefined when calling updateOrganizationSource().'
+            );
+        }
+
+        if (requestParameters['payload'] == null) {
+            throw new runtime.RequiredError(
+                'payload',
+                'Required parameter "payload" was null or undefined when calling updateOrganizationSource().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['payload'] != null) {
+            formParams.append('payload', new Blob([JSON.stringify(OrganizationSourceAuthenticationResultSchemaToJSON(requestParameters['payload']))], { type: "application/json", }));
+                    }
+
+        if (requestParameters['certificate'] != null) {
+            formParams.append('certificate', requestParameters['certificate'] as any);
+        }
+
+        const response = await this.request({
+            path: `/authentications/organizations/{organizationId}/sources/{sourceKey}`.replace(`{${"organizationId"}}`, encodeURIComponent(String(requestParameters['organizationId']))).replace(`{${"sourceKey"}}`, encodeURIComponent(String(requestParameters['sourceKey']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => OrganizationSourceAuthenticationResultSchemaFromJSON(jsonValue));
+    }
+
+    /**
+     * Update the credentials of a given source for an organization
+     */
+    async updateOrganizationSource(requestParameters: UpdateOrganizationSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrganizationSourceAuthenticationResultSchema> {
+        const response = await this.updateOrganizationSourceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,4 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ContactApi';
+export * from './OrganizationSourceAuthenticationApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/AddressLabel.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UCX Proxy
+ * A single use API for the UCX Proxy.
+ *
+ * The version of the OpenAPI document: 0.0.3-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const AddressLabel = {
+    HOME: 'HOME',
+    SECONDARY: 'SECONDARY',
+    WORK: 'WORK',
+    OTHER: 'OTHER',
+    UNKNOWN: 'UNKNOWN',
+    unknown_default_open_api: '11184809'
+} as const;
+export type AddressLabel = typeof AddressLabel[keyof typeof AddressLabel];
+
+
+export function instanceOfAddressLabel(value: any): boolean {
+    for (const key in AddressLabel) {
+        if (Object.prototype.hasOwnProperty.call(AddressLabel, key)) {
+            if (AddressLabel[key as keyof typeof AddressLabel] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function AddressLabelFromJSON(json: any): AddressLabel {
+    return AddressLabelFromJSONTyped(json, false);
+}
+
+export function AddressLabelFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddressLabel {
+    return json as AddressLabel;
+}
+
+export function AddressLabelToJSON(value?: AddressLabel | null): any {
+    return value as any;
+}
+
+export function AddressLabelToJSONTyped(value: any, ignoreDiscriminator: boolean): AddressLabel {
+    return value as AddressLabel;
+}
+

package/src/models/AddressSchema.ts

@@ -0,0 +1,133 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UCX Proxy
+ * A single use API for the UCX Proxy.
+ *
+ * The version of the OpenAPI document: 0.0.3-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * 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';
+import type { AddressLabel } from './AddressLabel';
+import {
+    AddressLabelFromJSON,
+    AddressLabelFromJSONTyped,
+    AddressLabelToJSON,
+    AddressLabelToJSONTyped,
+} from './AddressLabel';
+
+/**
+ * 
+ * @export
+ * @interface AddressSchema
+ */
+export interface AddressSchema {
+    /**
+     * 
+     * @type {AddressLabel}
+     * @memberof AddressSchema
+     */
+    label: AddressLabel;
+    /**
+     * 
+     * @type {string}
+     * @memberof AddressSchema
+     */
+    line1?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AddressSchema
+     */
+    line2?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AddressSchema
+     */
+    city?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AddressSchema
+     */
+    postalCode?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AddressSchema
+     */
+    state?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof AddressSchema
+     */
+    country?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AddressSchema
+     */
+    main: boolean;
+}
+
+
+
+/**
+ * Check if a given object implements the AddressSchema interface.
+ */
+export function instanceOfAddressSchema(value: object): value is AddressSchema {
+    if (!('label' in value) || value['label'] === undefined) return false;
+    if (!('main' in value) || value['main'] === undefined) return false;
+    return true;
+}
+
+export function AddressSchemaFromJSON(json: any): AddressSchema {
+    return AddressSchemaFromJSONTyped(json, false);
+}
+
+export function AddressSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddressSchema {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'label': AddressLabelFromJSON(json['label']),
+        'line1': json['line1'] == null ? undefined : json['line1'],
+        'line2': json['line2'] == null ? undefined : json['line2'],
+        'city': json['city'] == null ? undefined : json['city'],
+        'postalCode': json['postal_code'] == null ? undefined : json['postal_code'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'country': json['country'] == null ? undefined : json['country'],
+        'main': json['main'],
+    };
+}
+
+export function AddressSchemaToJSON(json: any): AddressSchema {
+    return AddressSchemaToJSONTyped(json, false);
+}
+
+export function AddressSchemaToJSONTyped(value?: AddressSchema | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'label': AddressLabelToJSON(value['label']),
+        'line1': value['line1'],
+        'line2': value['line2'],
+        'city': value['city'],
+        'postal_code': value['postalCode'],
+        'state': value['state'],
+        'country': value['country'],
+        'main': value['main'],
+    };
+}
+

package/src/models/ContactLanguage.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UCX Proxy
+ * A single use API for the UCX Proxy.
+ *
+ * The version of the OpenAPI document: 0.0.3-SNAPSHOT
+ * Contact: customersuccess@equisoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const ContactLanguage = {
+    ENGLISH: 'ENGLISH',
+    FRENCH: 'FRENCH',
+    unknown_default_open_api: '11184809'
+} as const;
+export type ContactLanguage = typeof ContactLanguage[keyof typeof ContactLanguage];
+
+
+export function instanceOfContactLanguage(value: any): boolean {
+    for (const key in ContactLanguage) {
+        if (Object.prototype.hasOwnProperty.call(ContactLanguage, key)) {
+            if (ContactLanguage[key as keyof typeof ContactLanguage] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ContactLanguageFromJSON(json: any): ContactLanguage {
+    return ContactLanguageFromJSONTyped(json, false);
+}
+
+export function ContactLanguageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContactLanguage {
+    return json as ContactLanguage;
+}
+
+export function ContactLanguageToJSON(value?: ContactLanguage | null): any {
+    return value as any;
+}
+
+export function ContactLanguageToJSONTyped(value: any, ignoreDiscriminator: boolean): ContactLanguage {
+    return value as ContactLanguage;
+}
+