@orbis-systems/orbis-api-clients 1.4.0 → 1.4.1

package/dist/uma/index.d.ts

@@ -254,6 +254,7 @@ export enum UmaErrorCode {
     ForbiddenByFirmsStatusErr = 4292,
     NotAcceptableError = 4600,
     InternalServerErr = 5000,
+    BadGatewayErr = 5020,
     InvalidRequest = 6000
 }
 export enum UmaTokenType {
@@ -612,12 +613,12 @@ export interface UmaGetEndpointsListSerializer {
     total_records: number;
 }
 export interface UmaFirmMutationSerializer {
-    firm: UmaFirmSerializer;
+    firm: UmaFirmWithCredsSerializer;
     status: number;
 }
 export interface UmaGetFirmsListSerializer {
     current_page: number;
-    firms_list: UmaFirmSerializer[];
+    firms_list: UmaFirmWithCredsSerializer[];
     pages_count: number;
     status: number;
     total_records: number;
@@ -1583,6 +1584,10 @@ export interface UmaCreateEndpointDto {
     route?: string;
     type?: UmaCreateEndpointDtoTypeEnum;
 }
+export interface UmaCreateFeedbackDto {
+    comment?: string;
+    subject?: string;
+}
 export interface UmaCreateFirmDto {
     allow_b2c_email_notifications?: boolean;
     allow_b2c_multi_branch_registration?: boolean;
@@ -1597,6 +1602,7 @@ export interface UmaCreateFirmDto {
     phone?: string;
     region?: string;
     slug?: string;
+    zendesk_credentials?: UmaFirmZendeskCredsDto;
 }
 export interface UmaCreateIdentityProviderDto {
     auth_url?: string;
@@ -1881,6 +1887,43 @@ export interface UmaFirmSerializer {
     updated_at: string;
     uuid: string;
 }
+export interface UmaFirmWithCredsSerializer {
+    admins_count: number;
+    allow_b2c_email_notifications: boolean;
+    allow_b2c_multi_branch_registration: boolean;
+    b2b_users_count: number;
+    b2c_access_token_expires_in_minutes: number;
+    b2c_refresh_token_expires_in_hours: number;
+    b2c_users_count: number;
+    branches: UmaBranchSerializer[];
+    branches_count: number;
+    /** @example "2022-02-02T00:00:00Z" */
+    created_at: string;
+    email: string;
+    /** @example 1 */
+    id: number;
+    is_emails_allowlist_enabled: boolean;
+    is_emails_blocklist_enabled: boolean;
+    last_status_change_at: string;
+    /** @example "ViewTrade" */
+    name: string;
+    notes: string;
+    phone: string;
+    region: string;
+    /** @example "viewtrade" */
+    slug: string;
+    status: string;
+    tags: UmaTagSerializer[];
+    /** @example "2022-02-02T00:00:00Z" */
+    updated_at: string;
+    uuid: string;
+    zendesk_credentials: UmaFirmZendeskCredsDto;
+}
+export interface UmaFirmZendeskCredsDto {
+    client_id?: string;
+    client_secret?: string;
+    subdomain?: string;
+}
 export interface UmaGenerateWatchmenAuthTokenDto {
     branch_id?: number;
     branch_uuid?: string;
@@ -2391,6 +2434,7 @@ export interface UmaPartialUpdateFirmDto {
     phone?: string;
     slug?: string;
     status?: UmaPartialUpdateFirmDtoStatusEnum;
+    zendesk_credentials?: UmaFirmZendeskCredsDto;
 }
 export interface UmaPartialUpdateMicroserviceDto {
     description?: string;
@@ -2843,6 +2887,7 @@ export interface UmaUpdateFirmDto {
     slug?: string;
     status?: UmaUpdateFirmDtoStatusEnum;
     updated_at?: string;
+    zendesk_credentials?: UmaFirmZendeskCredsDto;
 }
 export interface UmaUpdateIdentityProviderDto {
     auth_url?: string;
@@ -4662,6 +4707,19 @@ export class Endpoints<HandleError extends boolean = boolean, Format extends Cas
      */
     get(endpointDto: UmaGetEndpointsListDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<UmaGetEndpointsListSerializer, HandleError, Format>>;
 }
+export class Feedback<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
+    protected readonly apiClient: JwtClient<HandleError, Format>;
+    constructor(apiClient: JwtClient<HandleError, Format>);
+    /**
+     * @description Send the user's feedback to the Zendesk account configured for their firm. The Zendesk OAuth credentials are kept on the firm, so the client application never has to store them. `subject` is optional, up to 255 characters. `comment` is required, up to ZENDESK_MAX_COMMENT_LENGTH characters (2000 by default).
+     * @tags feedback
+     * @name Create
+     * @summary Send Feedback
+     * @request POST:/v1/feedback
+     * @secure
+     */
+    create(createFeedback: UmaCreateFeedbackDto, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
+}
 export class Firms<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
     protected readonly apiClient: JwtClient<HandleError, Format>;
     constructor(apiClient: JwtClient<HandleError, Format>);
@@ -5460,6 +5518,7 @@ export class UmaApi<HandleError extends boolean = false, Format extends CaseForm
     countries: Countries<HandleError, Format>;
     emailDomains: EmailDomains<HandleError, Format>;
     endpoints: Endpoints<HandleError, Format>;
+    feedback: Feedback<HandleError, Format>;
     firms: Firms<HandleError, Format>;
     identityProviders: IdentityProviders<HandleError, Format>;
     locales: Locales<HandleError, Format>;