@fenixalliance/abs-api-client 1.0.2 → 2.0.0

package/schemas/invoicingService/schema.s.ts

@@ -14,7 +14,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["InvoiceDtoListEnvelope"];
@@ -44,7 +44,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["EmptyEnvelope"];
@@ -61,6 +61,32 @@ export interface paths {
       };
     };
   };
+  "/api/v2/InvoicingService/Invoices/Extended": {
+    get: {
+      parameters: {
+        query: {
+          tenantId: string;
+          "api-version"?: string;
+        };
+      };
+      responses: {
+        /** @description OK */
+        200: {
+          content: {
+            "application/json": components["schemas"]["ExtendedInvoiceDtoListEnvelope"];
+            "application/xml": components["schemas"]["ExtendedInvoiceDtoListEnvelope"];
+          };
+        };
+        /** @description Not Found */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
   "/api/v2/InvoicingService/Invoices/{invoiceId}": {
     get: {
       parameters: {
@@ -73,7 +99,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["InvoiceDtoEnvelope"];
@@ -106,7 +132,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["EmptyEnvelope"];
@@ -133,7 +159,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["EmptyEnvelope"];
@@ -150,6 +176,35 @@ export interface paths {
       };
     };
   };
+  "/api/v2/InvoicingService/Invoices/{invoiceId}/Extended": {
+    get: {
+      parameters: {
+        query: {
+          tenantId: string;
+          "api-version"?: string;
+        };
+        path: {
+          invoiceId: string;
+        };
+      };
+      responses: {
+        /** @description OK */
+        200: {
+          content: {
+            "application/json": components["schemas"]["InvoiceDtoEnvelope"];
+            "application/xml": components["schemas"]["InvoiceDtoEnvelope"];
+          };
+        };
+        /** @description Not Found */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
   "/api/v2/InvoicingService/Invoices/{invoiceId}/Lines": {
     get: {
       parameters: {
@@ -163,7 +218,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["InvoiceLineDtoListEnvelope"];
@@ -196,7 +251,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["EmptyEnvelope"];
@@ -226,7 +281,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["InvoiceLineDtoEnvelope"];
@@ -260,7 +315,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["EmptyEnvelope"];
@@ -294,7 +349,7 @@ export interface paths {
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["EmptyEnvelope"];
@@ -312,19 +367,17 @@ export interface paths {
     };
   };
   "/api/v2/InvoicingService/Invoices/{invoiceId}/Payments": {
-    /** Get the list of payments related to an Invoice */
     get: {
       parameters: {
         query?: {
           "api-version"?: string;
         };
         path: {
-          /** @description The Invoice ID to get payments for. */
           invoiceId: string;
         };
       };
       responses: {
-        /** @description Success */
+        /** @description OK */
         200: {
           content: {
             "application/json": components["schemas"]["InvoiceDtoListEnvelope"];
@@ -348,12 +401,266 @@ export interface paths {
       };
     };
   };
+  "/api/v2/InvoicingService/Invoices/TotalsAggregate": {
+    post: {
+      parameters: {
+        query?: {
+          currencyId?: string;
+          "api-version"?: string;
+        };
+      };
+      requestBody: {
+        content: {
+          "application/json": string[];
+          "application/xml": string[];
+        };
+      };
+      responses: {
+        /** @description OK */
+        200: {
+          content: {
+            "application/json": components["schemas"]["MoneyEnvelope"];
+            "application/xml": components["schemas"]["MoneyEnvelope"];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+        /** @description Forbidden */
+        403: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/InvoicingService/Invoices/TaxesAggregate": {
+    post: {
+      parameters: {
+        query?: {
+          currencyId?: string;
+          "api-version"?: string;
+        };
+      };
+      requestBody: {
+        content: {
+          "application/json": string[];
+          "application/xml": string[];
+        };
+      };
+      responses: {
+        /** @description OK */
+        200: {
+          content: {
+            "application/json": components["schemas"]["MoneyEnvelope"];
+            "application/xml": components["schemas"]["MoneyEnvelope"];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+        /** @description Forbidden */
+        403: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/InvoicingService/Invoices/DiscountsAggregate": {
+    post: {
+      parameters: {
+        query?: {
+          currencyId?: string;
+          "api-version"?: string;
+        };
+      };
+      requestBody: {
+        content: {
+          "application/json": string[];
+          "application/xml": string[];
+        };
+      };
+      responses: {
+        /** @description OK */
+        200: {
+          content: {
+            "application/json": components["schemas"]["MoneyEnvelope"];
+            "application/xml": components["schemas"]["MoneyEnvelope"];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+        /** @description Forbidden */
+        403: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/InvoicingService/Invoices/TaxBasesAggregate": {
+    post: {
+      parameters: {
+        query?: {
+          currencyId?: string;
+          "api-version"?: string;
+        };
+      };
+      requestBody: {
+        content: {
+          "application/json": string[];
+          "application/xml": string[];
+        };
+      };
+      responses: {
+        /** @description OK */
+        200: {
+          content: {
+            "application/json": components["schemas"]["MoneyEnvelope"];
+            "application/xml": components["schemas"]["MoneyEnvelope"];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+        /** @description Forbidden */
+        403: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
+  "/api/v2/InvoicingService/Invoices/GlobalSurchargesAggregate": {
+    post: {
+      parameters: {
+        query?: {
+          currencyId?: string;
+          "api-version"?: string;
+        };
+      };
+      requestBody: {
+        content: {
+          "application/json": string[];
+          "application/xml": string[];
+        };
+      };
+      responses: {
+        /** @description OK */
+        200: {
+          content: {
+            "application/json": components["schemas"]["MoneyEnvelope"];
+            "application/xml": components["schemas"]["MoneyEnvelope"];
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+        /** @description Forbidden */
+        403: {
+          content: {
+            "application/json": components["schemas"]["ErrorEnvelope"];
+            "application/xml": components["schemas"]["ErrorEnvelope"];
+          };
+        };
+      };
+    };
+  };
 }
 
 export type webhooks = Record<string, never>;
 
 export interface components {
   schemas: {
+    ContactDto: {
+      id?: string | null;
+      /** Format: date-time */
+      timestamp?: string | null;
+      tenantId?: string | null;
+      /**
+       * Format: int32
+       * @enum {integer}
+       */
+      type?: 0 | 1;
+      taxId?: string | null;
+      firstName?: string | null;
+      lastName?: string | null;
+      primaryContactId?: string | null;
+      qualifiedName?: string | null;
+      email?: string | null;
+      about?: string | null;
+      mobilePhone?: string | null;
+      businessPhone?: string | null;
+      jobTitle?: string | null;
+      avatarUrl?: string | null;
+      coverUrl?: string | null;
+      websiteUrl?: string | null;
+      facebookUrl?: string | null;
+      twitterUrl?: string | null;
+      youtubeUrl?: string | null;
+      linkedInUrl?: string | null;
+      githubUsername?: string | null;
+      street?: string | null;
+      zipCode?: string | null;
+      cartId?: string | null;
+      walletId?: string | null;
+      cityId?: string | null;
+      stateId?: string | null;
+      countryId?: string | null;
+      languageId?: string | null;
+      currencyId?: string | null;
+      timezoneId?: string | null;
+      territoryId?: string | null;
+      enrollmentId?: string | null;
+      ownerContactId?: string | null;
+      relatedTenantId?: string | null;
+      activityFeedId?: string | null;
+      parentContactId?: string | null;
+      socialProfileId?: string | null;
+      activeDirectoryId?: string | null;
+      identityProvider?: string | null;
+      identityProviderAccessToken?: string | null;
+      postalCode?: string | null;
+      relatedUserId?: string | null;
+      partnerProfileId?: string | null;
+      webUrl?: string | null;
+      /** Format: date-time */
+      birthday?: string | null;
+    };
+    Currency: {
+      code?: string | null;
+      country?: string | null;
+    };
     EmptyEnvelope: {
       errorMessage?: string | null;
       isSuccess?: boolean;
@@ -369,6 +676,56 @@ export interface components {
       activityId?: string | null;
       correlationId?: string | null;
     };
+    ExtendedInvoiceDto: {
+      id?: string | null;
+      /** Format: date-time */
+      timestamp?: string | null;
+      currencyId?: string | null;
+      receiverTenantId?: string | null;
+      orderId?: string | null;
+      tenantId?: string | null;
+      /** Format: double */
+      forexRate?: number;
+      /** Format: double */
+      totalAmountInUsd?: number;
+      enumeration?: string | null;
+      /** Format: double */
+      totalSurchargesInUsd?: number;
+      /** Format: double */
+      totalGlobalDiscountsInUsd?: number;
+      /** Format: double */
+      totalGlobalSurchargesInUsd?: number;
+      /** Format: double */
+      totalTaxesInUsd?: number;
+      /** Format: double */
+      totalTaxBaseInUsd?: number;
+      /** Format: double */
+      totalDiscountsInUsd?: number;
+      userId?: string | null;
+      receptorBusinessId?: string | null;
+      enrollmentId?: string | null;
+      organizationId?: string | null;
+      individualId?: string | null;
+      /**
+       * Format: int32
+       * @enum {integer}
+       */
+      documentType?: 0 | 1 | 2;
+      tenant?: components["schemas"]["TenantDto"];
+      user?: components["schemas"]["PlatformUserDto"];
+      individual?: components["schemas"]["ContactDto"];
+      organization?: components["schemas"]["ContactDto"];
+      enrollment?: components["schemas"]["TenantEnrolmentDto"];
+    };
+    ExtendedInvoiceDtoListEnvelope: {
+      errorMessage?: string | null;
+      isSuccess?: boolean;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      correlationId?: string | null;
+      result?: components["schemas"]["ExtendedInvoiceDto"][] | null;
+    };
     InvoiceCreateDto: {
       /** Format: uuid */
       id?: string;
@@ -381,12 +738,37 @@ export interface components {
       id?: string | null;
       /** Format: date-time */
       timestamp?: string | null;
-      orderID?: string | null;
-      businessID?: string | null;
+      currencyId?: string | null;
+      receiverTenantId?: string | null;
+      orderId?: string | null;
+      tenantId?: string | null;
       /** Format: double */
       forexRate?: number;
       /** Format: double */
       totalAmountInUsd?: number;
+      enumeration?: string | null;
+      /** Format: double */
+      totalSurchargesInUsd?: number;
+      /** Format: double */
+      totalGlobalDiscountsInUsd?: number;
+      /** Format: double */
+      totalGlobalSurchargesInUsd?: number;
+      /** Format: double */
+      totalTaxesInUsd?: number;
+      /** Format: double */
+      totalTaxBaseInUsd?: number;
+      /** Format: double */
+      totalDiscountsInUsd?: number;
+      userId?: string | null;
+      receptorBusinessId?: string | null;
+      enrollmentId?: string | null;
+      organizationId?: string | null;
+      individualId?: string | null;
+      /**
+       * Format: int32
+       * @enum {integer}
+       */
+      documentType?: 0 | 1 | 2;
     };
     InvoiceDtoEnvelope: {
       errorMessage?: string | null;
@@ -408,15 +790,19 @@ export interface components {
     };
     InvoiceLineDto: {
       id?: string | null;
+      /** Format: date-time */
+      timestamp?: string | null;
       closed?: boolean;
       itemId?: string | null;
+      itemTitle?: string | null;
+      itemShortDescription?: string | null;
+      itemPrimaryImageUrl?: string | null;
+      shippingPolicyId?: string | null;
       businessId?: string | null;
       currencyId?: string | null;
       description?: string | null;
       /** Format: double */
       quantity?: number;
-      /** Format: date-time */
-      timestamp?: string;
       free?: boolean;
       freeReason?: string | null;
       freeReasonCode?: string | null;
@@ -575,6 +961,131 @@ export interface components {
       discountListId?: string | null;
       roundingPolicyId?: string | null;
     };
+    Money: {
+      /** Format: double */
+      amount?: number;
+      currency?: components["schemas"]["Currency"];
+    };
+    MoneyEnvelope: {
+      errorMessage?: string | null;
+      isSuccess?: boolean;
+      /** Format: date-time */
+      timestamp?: string;
+      activityId?: string | null;
+      correlationId?: string | null;
+      result?: components["schemas"]["Money"];
+    };
+    PlatformUserDto: {
+      id?: string | null;
+      /** Format: date-time */
+      timestamp?: string | null;
+      qualifiedName?: string | null;
+      /** Format: date-time */
+      birthday?: string;
+      firstName?: string | null;
+      lastName?: string | null;
+      publicName?: string | null;
+      idProvider?: string | null;
+      languageId?: string | null;
+      timezoneId?: string | null;
+      /**
+       * Format: int32
+       * @enum {integer}
+       */
+      gender?: 0 | 1 | 2;
+      cityId?: string | null;
+      stateId?: string | null;
+      email?: string | null;
+      about?: string | null;
+      jobTitle?: string | null;
+      coverUrl?: string | null;
+      avatarUrl?: string | null;
+      gitHubUrl?: string | null;
+      websiteUrl?: string | null;
+      twitterUrl?: string | null;
+      facebookUrl?: string | null;
+      youTubeUrl?: string | null;
+      linkedInUrl?: string | null;
+      instagramUrl?: string | null;
+      lockoutEnabled?: boolean;
+      socialFeedId?: string | null;
+      socialProfileId?: string | null;
+      currentTenantId?: string | null;
+      currentEnrollmentId?: string | null;
+      cartId?: string | null;
+      walletId?: string | null;
+      countryId?: string | null;
+      currencyId?: string | null;
+      userName?: string | null;
+      status?: string | null;
+      phoneNumber?: string | null;
+      publicIdentifier?: string | null;
+      identityProvider?: string | null;
+      phoneNumberConfirmed?: boolean;
+      emailConfirmed?: boolean;
+      /**
+       * Format: int32
+       * @enum {integer}
+       */
+      availability?: 0 | 1 | 2 | 3 | 4;
+      /** Format: int32 */
+      enrollmentsCount?: number | null;
+      /**
+       * Format: int32
+       * @enum {integer}
+       */
+      siteTheme?: 0 | 1 | 2;
+    };
+    TenantDto: {
+      id?: string | null;
+      /** Format: date-time */
+      timestamp?: string | null;
+      qualifiedName?: string | null;
+      taxId?: string | null;
+      about?: string | null;
+      walletId?: string | null;
+      socialFeedId?: string | null;
+      businessIndustryId?: string | null;
+      businessSegmentId?: string | null;
+      socialProfileId?: string | null;
+      languageId?: string | null;
+      name?: string | null;
+      duns?: string | null;
+      slogan?: string | null;
+      legalName?: string | null;
+      coverUrl?: string | null;
+      avatarUrl?: string | null;
+      cartId?: string | null;
+      currencyId?: string | null;
+      timezoneId?: string | null;
+      countryId?: string | null;
+      stateId?: string | null;
+      cityId?: string | null;
+      email?: string | null;
+      phone?: string | null;
+      webUrl?: string | null;
+      facebookUrl?: string | null;
+      twitterUrl?: string | null;
+      gitHubUrl?: string | null;
+      linkedInUrl?: string | null;
+      instagramUrl?: string | null;
+      youTubeUrl?: string | null;
+      whatsAppNumber?: string | null;
+      supportPhoneNumber?: string | null;
+      verified?: boolean;
+      businessName?: string | null;
+      businessLegalName?: string | null;
+      twitterUsername?: string | null;
+    };
+    TenantEnrolmentDto: {
+      id?: string | null;
+      isRoot?: boolean;
+      isOwner?: boolean;
+      isAdmin?: boolean;
+      isDisabled?: boolean;
+      tenantId?: string | null;
+      userId?: string | null;
+    };
   };
   responses: never;
   parameters: never;