rebilly-js-sdk 47.7.0 → 47.8.0

package/dist/rebilly-js-sdk.d.ts

@@ -339,6 +339,57 @@ declare module rebilly {
   type DeleteInvoiceTimelineResponse = operations['DeleteInvoiceTimeline']['responses']['204']
   type DeleteInvoiceTimelineResponsePromise = Promise<{fields: DeleteInvoiceTimelineResponse}>
   
+  type GetCreditMemoCollectionRequest = operations['GetCreditMemoCollection']['parameters']["query"] & (operations['GetCreditMemoCollection']['parameters'] extends {path: {}} ? operations['GetCreditMemoCollection']['parameters']["path"] : {})
+  
+  type GetCreditMemoCollectionResponse = operations['GetCreditMemoCollection']['responses']['200']['content']['application/json'][0]
+  type GetCreditMemoCollectionResponsePromise = Promise<{ items: {fields: GetCreditMemoCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
+  type PostCreditMemoRequest = operations['PostCreditMemo']['requestBody']['content']['application/json']
+  type CreateCreditMemoRequest = { id: String,  data: PostCreditMemoRequest, expand?: String }
+  type PostCreditMemoResponse = operations['PostCreditMemo']['responses']['201']['content']['application/json']
+  type PostCreditMemoResponsePromise = Promise<{fields: PostCreditMemoResponse}>
+  
+  type GetCreditMemoRequest = operations['GetCreditMemo']['parameters'] & { id : String }
+  
+  type GetCreditMemoResponse = operations['GetCreditMemo']['responses']['200']['content']['application/json']
+  type GetCreditMemoResponsePromise = Promise<{fields: GetCreditMemoResponse}>
+  type PutCreditMemoRequest = operations['PutCreditMemo']['requestBody']['content']['application/json']
+  type PutCreditMemoResponse = operations['PutCreditMemo']['responses']['201']['content']['application/json']
+  type PutCreditMemoResponsePromise = Promise<{fields: PutCreditMemoResponse}>
+  
+  type PostCreditMemoVoidResponse = operations['PostCreditMemoVoid']['responses']['201']['content']['application/json']
+  type PostCreditMemoVoidResponsePromise = Promise<{fields: PostCreditMemoVoidResponse}>
+  
+  type GetCreditMemoTimelineCollectionRequest = operations['GetCreditMemoTimelineCollection']['parameters']["query"] & (operations['GetCreditMemoTimelineCollection']['parameters'] extends {path: {}} ? operations['GetCreditMemoTimelineCollection']['parameters']["path"] : {}) & { id : String }
+  
+  type GetCreditMemoTimelineCollectionResponse = operations['GetCreditMemoTimelineCollection']['responses']['200']['content']['application/json'][0]
+  type GetCreditMemoTimelineCollectionResponsePromise = Promise<{ items: {fields: GetCreditMemoTimelineCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
+  type PostCreditMemoTimelineRequest = operations['PostCreditMemoTimeline']['requestBody']['content']['application/json']
+  type CreateCreditMemoTimelineRequest = { id: String,  data: PostCreditMemoTimelineRequest, expand?: String }
+  type PostCreditMemoTimelineResponse = operations['PostCreditMemoTimeline']['responses']['201']['content']['application/json']
+  type PostCreditMemoTimelineResponsePromise = Promise<{fields: PostCreditMemoTimelineResponse}>
+  
+  type GetCreditMemoTimelineRequest = { id : String,messageId : String }
+
+  type GetCreditMemoTimelineResponse = operations['GetCreditMemoTimeline']['responses']['200']['content']['application/json']
+  type GetCreditMemoTimelineResponsePromise = Promise<{fields: GetCreditMemoTimelineResponse}>
+  type DeleteCreditMemoTimelineResponse = operations['DeleteCreditMemoTimeline']['responses']['204']
+  type DeleteCreditMemoTimelineResponsePromise = Promise<{fields: DeleteCreditMemoTimelineResponse}>
+  
+  type GetInvoiceCreditMemoAllocationCollectionRequest = operations['GetInvoiceCreditMemoAllocationCollection']['parameters']["query"] & (operations['GetInvoiceCreditMemoAllocationCollection']['parameters'] extends {path: {}} ? operations['GetInvoiceCreditMemoAllocationCollection']['parameters']["path"] : {}) & { id : String }
+  
+  type GetInvoiceCreditMemoAllocationCollectionResponse = operations['GetInvoiceCreditMemoAllocationCollection']['responses']['200']['content']['application/json'][0]
+  type GetInvoiceCreditMemoAllocationCollectionResponsePromise = Promise<{ items: {fields: GetInvoiceCreditMemoAllocationCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
+  
+  type GetInvoiceCreditMemoAllocationRequest = operations['GetInvoiceCreditMemoAllocation']['parameters'] & { id : String,creditMemoId : String }
+  
+  type GetInvoiceCreditMemoAllocationResponse = operations['GetInvoiceCreditMemoAllocation']['responses']['200']['content']['application/json']
+  type GetInvoiceCreditMemoAllocationResponsePromise = Promise<{fields: GetInvoiceCreditMemoAllocationResponse}>
+  type PutInvoiceCreditMemoAllocationRequest = operations['PutInvoiceCreditMemoAllocation']['requestBody']['content']['application/json']
+  type PutInvoiceCreditMemoAllocationResponse = operations['PutInvoiceCreditMemoAllocation']['responses']['200']['content']['application/json']
+  type PutInvoiceCreditMemoAllocationResponsePromise = Promise<{fields: PutInvoiceCreditMemoAllocationResponse}>
+  type DeleteInvoiceCreditMemoAllocationResponse = operations['DeleteInvoiceCreditMemoAllocation']['responses']['204']
+  type DeleteInvoiceCreditMemoAllocationResponsePromise = Promise<{fields: DeleteInvoiceCreditMemoAllocationResponse}>
+  
   type GetKycRequestCollectionRequest = operations['GetKycRequestCollection']['parameters']["query"] & (operations['GetKycRequestCollection']['parameters'] extends {path: {}} ? operations['GetKycRequestCollection']['parameters']["path"] : {})
   
   type GetKycRequestCollectionResponse = operations['GetKycRequestCollection']['responses']['200']['content']['application/json'][0]
@@ -397,6 +448,9 @@ declare module rebilly {
   type PostKycDocumentStopReviewResponse = operations['PostKycDocumentStopReview']['responses']['201']['content']['application/json']
   type PostKycDocumentStopReviewResponsePromise = Promise<{fields: PostKycDocumentStopReviewResponse}>
   
+  
+  type GetKycSettingsResponse = operations['GetKycSettings']['responses']['200']['content']['application/json']
+  type GetKycSettingsResponsePromise = Promise<{fields: GetKycSettingsResponse}>
   type PutKycSettingsRequest = operations['PutKycSettings']['requestBody']['content']['application/json']
   type PutKycSettingsResponse = operations['PutKycSettings']['responses']['200']['content']['application/json']
   type PutKycSettingsResponsePromise = Promise<{fields: PutKycSettingsResponse}>
@@ -2439,6 +2493,89 @@ export interface corePaths {
       };
     };
   };
+  "/credit-memos": {
+    /** Retrieve a list of credit memos. */
+    get: operations["GetCreditMemoCollection"];
+    /** Create a credit memo. */
+    post: operations["PostCreditMemo"];
+  };
+  "/credit-memos/{id}": {
+    /** Retrieve a credit memo with specified identifier string. */
+    get: operations["GetCreditMemo"];
+    /** Create or update a credit memo with predefined identifier string. */
+    put: operations["PutCreditMemo"];
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
+  "/credit-memos/{id}/void": {
+    /** Void a credit memo with a specified identifier string. */
+    post: operations["PostCreditMemoVoid"];
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
+  "/credit-memos/{id}/timeline": {
+    /** Retrieve a list of credit memo timeline messages. */
+    get: operations["GetCreditMemoTimelineCollection"];
+    /** Create a credit memo timeline message. */
+    post: operations["PostCreditMemoTimeline"];
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
+  "/credit-memos/{id}/timeline/{messageId}": {
+    /** Retrieve a credit memo timeline message with specified identifier string. */
+    get: operations["GetCreditMemoTimeline"];
+    /** Delete a credit memo timeline message with predefined identifier string. */
+    delete: operations["DeleteCreditMemoTimeline"];
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** The credit memo timeline message ID. */
+        messageId: string;
+      };
+    };
+  };
+  "/invoices/{id}/credit-memo-allocations": {
+    /** Get the precise amounts from a credit memo allocated to the invoice. */
+    get: operations["GetInvoiceCreditMemoAllocationCollection"];
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
+  "/invoices/{id}/credit-memo-allocations/{creditMemoId}": {
+    /** Get the allocation from the given credit memo to the given invoice with the credit amount. */
+    get: operations["GetInvoiceCreditMemoAllocation"];
+    /** Apply a credit memo to an invoice. The invoice must be unpaid. The credit memo must have a non-zero unused amount (not fully applied to other invoices). */
+    put: operations["PutInvoiceCreditMemoAllocation"];
+    /**
+     * Delete the allocation which is taken from the given credit memo to the given invoice.
+     * Both invoice's and credit memo's total amounts change, possibly with their statuses.
+     */
+    delete: operations["DeleteInvoiceCreditMemoAllocation"];
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** Credit memo ID. */
+        creditMemoId: string;
+      };
+    };
+  };
   "/kyc-requests": {
     /** Retrieve a list of KYC requests. */
     get: operations["GetKycRequestCollection"];
@@ -2546,6 +2683,8 @@ export interface corePaths {
     };
   };
   "/kyc-settings": {
+    /** Retrieve KYC settings. */
+    get: operations["GetKycSettings"];
     /** Update KYC settings. */
     put: operations["PutKycSettings"];
   };
@@ -5167,6 +5306,78 @@ export interface coreComponents {
     };
     /** eMerchantPay 3DS Server. */
     eMerchantPay3dsServer: coreComponents["schemas"]["eMerchantPay3dsServers"];
+    /** ThreeDSecureIO3dsServer. */
+    ThreeDSecureIO3dsServer: coreComponents["schemas"]["WorldlineAtosFrankfurt3dsServers"] &
+      coreComponents["schemas"]["TestProcessor3dsServers"] &
+      coreComponents["schemas"]["EMS3dsServers"] & {
+        /** Visa acquirer merchant ID (MID). */
+        acquirerMerchantIdVisa: string;
+        /** Mastercard acquirer merchant ID (MID). */
+        acquirerMerchantIdMastercard: string;
+        /** Merchant Name. */
+        merchantName: string;
+        /** Visa Acquirer BIN. */
+        merchantAcquirerBinVisa: string;
+        /** Mastercard Acquirer BIN. */
+        merchantAcquirerBinMastercard: string;
+        /** Merchant Country ISO Alpha-2 Code. */
+        merchantCountry: string;
+        /** Merchant URL. */
+        merchantUrl: string;
+        /**
+         * Value determines if requests can use version 1 of 3DS.
+         * In case both v1 and v2 are enabled it will prefer v2.
+         * If v2 is not supported for the issuer, it will coalesce to v1.
+         */
+        v1?: boolean;
+        /**
+         * Value determines if requests will attempt version 2 of 3DS.
+         * In case both v1 and v2 are enabled it will prefer v2.
+         * If v2 is not supported for the issuer, it will coalesce to v1.
+         */
+        v2?: boolean;
+        /**
+         * 01 - Goods/Service Purchase
+         * 03 - Check Acceptance
+         * 10 - Account Funding
+         * 11 - Quasi-Cash Transaction
+         * 28 - Prepaid Activation and Load
+         *
+         * Identifies the type of transaction being authenticated.
+         */
+        transactionType?: "01" | "03" | "10" | "11" | "28";
+        /** Set to true to decline transactions if a card is not enrolled instead of continuing without 3DS. */
+        declineNotEnrolled: boolean;
+        /** Use 3DS for merchant initiated transactions. */
+        use3dsForMerchantInitiated: boolean;
+        /**
+         * 01 - Recurring transaction
+         * 02 - Instalment transaction
+         * 03 - Add card
+         * 04 - Maintain card information
+         * 05 - Account verification
+         * 06 - Split/delayed shipment
+         * 07 - Top-up
+         * 08 - Mail Order
+         * 09 - Telephone Order
+         * 10 - Whitelist status check
+         * 11 - Other payment
+         *
+         * Indicates the type of 3RI request. Values 06 - 11 are only supported in 3D2 2.2.0.
+         */
+        threeRIInd?:
+          | "01"
+          | "02"
+          | "03"
+          | "04"
+          | "05"
+          | "06"
+          | "07"
+          | "08"
+          | "09"
+          | "10"
+          | "11";
+      };
     /** The Merchant plug-in Name. */
     ThreeDSecureServerName:
       | "Payvision3dsServer"
@@ -5185,76 +5396,19 @@ export interface coreComponents {
       | "Piastrix3dsServer"
       | "NGenius3dsServer"
       | "Stripe3dsServer";
-    /** ThreeDSecureIO3dsServer. */
-    ThreeDSecureIO3dsServer: {
+    /** WorldlineAtosFrankfurt 3DS Servers. */
+    WorldlineAtosFrankfurt3dsServers: {
+      name: "ThreeDSecureIO3dsServer";
+    };
+    /** TestProcessor3dsServers 3DS Servers. */
+    TestProcessor3dsServers: {
+      name: "TestSandbox3dsServer" | "ThreeDSecureIO3dsServer";
+    };
+    /** TestProcessor Integrated. */
+    TestProcessor3dsServer: coreComponents["schemas"]["TestProcessor3dsServers"];
+    /** EMS 3DS Servers. */
+    EMS3dsServers: {
       name: "ThreeDSecureIO3dsServer";
-      /** Visa acquirer merchant ID (MID). */
-      acquirerMerchantIdVisa: string;
-      /** Mastercard acquirer merchant ID (MID). */
-      acquirerMerchantIdMastercard: string;
-      /** Merchant Name. */
-      merchantName: string;
-      /** Visa Acquirer BIN. */
-      merchantAcquirerBinVisa: string;
-      /** Mastercard Acquirer BIN. */
-      merchantAcquirerBinMastercard: string;
-      /** Merchant Country ISO Alpha-2 Code. */
-      merchantCountry: string;
-      /** Merchant URL. */
-      merchantUrl: string;
-      /**
-       * Value determines if requests can use version 1 of 3DS.
-       * In case both v1 and v2 are enabled it will prefer v2.
-       * If v2 is not supported for the issuer, it will coalesce to v1.
-       */
-      v1?: boolean;
-      /**
-       * Value determines if requests will attempt version 2 of 3DS.
-       * In case both v1 and v2 are enabled it will prefer v2.
-       * If v2 is not supported for the issuer, it will coalesce to v1.
-       */
-      v2?: boolean;
-      /**
-       * 01 - Goods/Service Purchase
-       * 03 - Check Acceptance
-       * 10 - Account Funding
-       * 11 - Quasi-Cash Transaction
-       * 28 - Prepaid Activation and Load
-       *
-       * Identifies the type of transaction being authenticated.
-       */
-      transactionType?: "01" | "03" | "10" | "11" | "28";
-      /** Set to true to decline transactions if a card is not enrolled instead of continuing without 3DS. */
-      declineNotEnrolled: boolean;
-      /** Use 3DS for merchant initiated transactions. */
-      use3dsForMerchantInitiated: boolean;
-      /**
-       * 01 - Recurring transaction
-       * 02 - Instalment transaction
-       * 03 - Add card
-       * 04 - Maintain card information
-       * 05 - Account verification
-       * 06 - Split/delayed shipment
-       * 07 - Top-up
-       * 08 - Mail Order
-       * 09 - Telephone Order
-       * 10 - Whitelist status check
-       * 11 - Other payment
-       *
-       * Indicates the type of 3RI request. Values 06 - 11 are only supported in 3D2 2.2.0.
-       */
-      threeRIInd?:
-        | "01"
-        | "02"
-        | "03"
-        | "04"
-        | "05"
-        | "06"
-        | "07"
-        | "08"
-        | "09"
-        | "10"
-        | "11";
     };
     /** GET 3DS Servers. */
     GET3dsServers: {
@@ -6000,10 +6154,6 @@ export interface coreComponents {
         ssl_pin: string;
       };
     };
-    /** EMS 3DS Servers. */
-    EMS3dsServers: {
-      name: "ThreeDSecureIO3dsServer";
-    };
     /** EMS e-Commerce (XML) API config. */
     EMS: coreComponents["schemas"]["GatewayAccount"] & {
       /** EMS settings object. */
@@ -7431,12 +7581,6 @@ export interface coreComponents {
         transactionDescription?: string;
       };
     };
-    /** TestProcessor3dsServers 3DS Servers. */
-    TestProcessor3dsServers: {
-      name: "TestSandbox3dsServer" | "ThreeDSecureIO3dsServer";
-    };
-    /** TestProcessor Integrated. */
-    TestProcessor3dsServer: coreComponents["schemas"]["TestProcessor3dsServers"];
     /** TestProcessor Gateway config. */
     TestProcessor: coreComponents["schemas"]["GatewayAccount"] & {
       threeDSecureServer?: coreComponents["schemas"]["TestProcessor3dsServers"];
@@ -7625,10 +7769,6 @@ export interface coreComponents {
       };
       threeDSecureServer?: coreComponents["schemas"]["Wirecard3dsServers"];
     };
-    /** WorldlineAtosFrankfurt 3DS Servers. */
-    WorldlineAtosFrankfurt3dsServers: {
-      name: "ThreeDSecureIO3dsServer";
-    };
     /** WorldlineAtosFrankfurt Gateway config. */
     WorldlineAtosFrankfurt: coreComponents["schemas"]["GatewayAccount"] & {
       threeDSecureServer?: coreComponents["schemas"]["WorldlineAtosFrankfurt3dsServers"];
@@ -9114,6 +9254,109 @@ export interface coreComponents {
       /** The links related to resource. */
       _links?: coreComponents["schemas"]["SelfLink"][];
     };
+    /** Credit memo object. */
+    CreditMemo: {
+      /** Credit memo ID. */
+      id?: coreComponents["schemas"]["ResourceId"];
+      /** ID of the invoice which the credit memo is issued upon. */
+      invoiceId?: coreComponents["schemas"]["ResourceId"] | null;
+      /** Customer's ID. */
+      customerId: coreComponents["schemas"]["ResourceId"];
+      /** An auto-incrementing number based on the sequence of credit memos for any particular customer. */
+      number?: number;
+      items?: {
+        /** Credit memo item ID. */
+        id?: coreComponents["schemas"]["ResourceId"];
+        /** An invoice item's ID that the credit item is referenced to. */
+        invoiceItemId?: coreComponents["schemas"]["ResourceId"] | null;
+        /** Credit memo item's description. */
+        description?: string;
+        /** Credit memo item's price. */
+        unitPrice: number;
+        /** Credit memo item's quantity. */
+        quantity: number;
+        /** Credit memo item's total price. */
+        price?: number;
+        /** The related product's ID. */
+        productId?: coreComponents["schemas"]["ResourceId"] | null;
+        /** The related plan's ID. */
+        planId?: coreComponents["schemas"]["ResourceId"] | null;
+      }[];
+      /** Status of the credit memo. */
+      status?: "issued" | "applied" | "partially-applied" | "voided";
+      /** Credit memo reason code. */
+      reason?:
+        | "return"
+        | "product-unsatisfactory"
+        | "order-change"
+        | "order-cancellation"
+        | "chargeback"
+        | "write-off"
+        | "waiver"
+        | "customer-credit"
+        | "other";
+      /** A public description (visible to customers) clarifying the purpose of the credit memo. */
+      description?: string;
+      currency: coreComponents["schemas"]["CurrencyCode"];
+      /** The (invoice's) shipping amount to credit. */
+      shippingAmount: number;
+      /** The (invoice's) tax amount to credit. */
+      taxAmount: number;
+      /** The (invoice's) discount amount to credit. */
+      discountAmount: number;
+      /** The sum of all credits in the credit memo (items, shipping, tax, discount). */
+      totalAmount: number;
+      /** The amount of `totalAmount` which hasn't been allocated anywhere yet. */
+      unusedAmount: number;
+      /** Increments when the credit memo is modified. */
+      revision?: number;
+      /** Credit memo created time. */
+      createdTime?: coreComponents["schemas"]["ServerTimestamp"];
+      /** Credit memo updated time. */
+      updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
+      /** The links related to resource. */
+      _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
+        Partial<coreComponents["schemas"]["CustomerLink"]> &
+        Partial<coreComponents["schemas"]["InvoiceLink"]>)[];
+    };
+    CreditMemoTimeline: {
+      /** The Timeline message identifier string. */
+      id?: coreComponents["schemas"]["ResourceId"];
+      /** Timeline message type. */
+      type?:
+        | "credit-memo-issued"
+        | "credit-memo-partially-applied"
+        | "credit-memo-applied";
+      /** Shows who or what triggered the Timeline event. */
+      triggeredBy?: "rebilly" | "app" | "direct-api";
+      /** The message that describes the message details. */
+      message?: string;
+      extraData?: coreComponents["schemas"]["TimelineExtraData"];
+      /** Timeline message time. */
+      occurredTime?: coreComponents["schemas"]["ServerTimestamp"];
+      /** The links related to resource. */
+      _links?: coreComponents["schemas"]["SelfLink"][];
+    };
+    CreditMemoLink: coreComponents["schemas"]["Link"] & {
+      /** The link type. */
+      rel: "creditMemo";
+    };
+    CreditMemoAllocation: {
+      /** ID of the invoice where the credit memo is allocated to. */
+      invoiceId?: coreComponents["schemas"]["ResourceId"];
+      /** ID of the credit memo that was allocated. */
+      creditMemoId?: coreComponents["schemas"]["ResourceId"];
+      /** Amount of credit from the credit memo allocated to the given invoice. */
+      amount: number;
+      currency?: coreComponents["schemas"]["CurrencyCode"];
+      /** Credit memo allocation time. */
+      createdTime?: coreComponents["schemas"]["ServerTimestamp"];
+      /** Credit memo allocation update time. */
+      updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
+      /** The links related to the resource. */
+      _links?: (Partial<coreComponents["schemas"]["InvoiceLink"]> &
+        Partial<coreComponents["schemas"]["CreditMemoLink"]>)[];
+    };
     KycDocumentTypes:
       | "identity-proof"
       | "address-proof"
@@ -13618,6 +13861,352 @@ export interface operations {
       409: coreComponents["responses"]["Conflict"];
     };
   };
+  /** Retrieve a list of credit memos. */
+  GetCreditMemoCollection: {
+    parameters: {
+      query: {
+        /**
+         * The collection items filter requires a special format.
+         * Use "," for multiple allowed values.  Use ";" for multiple fields.
+         * See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
+         */
+        filter?: coreComponents["parameters"]["collectionFilter"];
+        /** The collection items sort field and order (prefix with "-" for descending sort). */
+        sort?: coreComponents["parameters"]["collectionSort"];
+        /** The collection items limit. */
+        limit?: coreComponents["parameters"]["collectionLimit"];
+        /** The collection items offset. */
+        offset?: coreComponents["parameters"]["collectionOffset"];
+        /** The partial search of the text fields. */
+        q?: coreComponents["parameters"]["collectionQuery"];
+        /**
+         * Expand a response to get a full related object included inside of the `_embedded` path in the response.
+         * It accepts a comma-separated list of objects to expand.
+         * See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
+         */
+        expand?: coreComponents["parameters"]["collectionExpand"];
+      };
+    };
+    responses: {
+      /** A list of credit memos was retrieved successfully. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemo"][];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+    };
+  };
+  /** Create a credit memo. */
+  PostCreditMemo: {
+    responses: {
+      /** CreditMemo was created. */
+      201: {
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemo"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      422: coreComponents["responses"]["ValidationError"];
+    };
+    requestBody: {
+      content: {
+        "application/json": coreComponents["schemas"]["CreditMemo"];
+      };
+    };
+  };
+  /** Retrieve a credit memo with specified identifier string. */
+  GetCreditMemo: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+      query: {
+        /**
+         * Expand a response to get a full related object included inside of the `_embedded` path in the response.
+         * It accepts a comma-separated list of objects to expand.
+         * See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
+         */
+        expand?: coreComponents["parameters"]["collectionExpand"];
+      };
+    };
+    responses: {
+      /** Credit memo was retrieved successfully. */
+      200: {
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemo"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+    };
+  };
+  /** Create or update a credit memo with predefined identifier string. */
+  PutCreditMemo: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** CreditMemo was updated. */
+      200: {
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemo"];
+        };
+      };
+      /** CreditMemo was created. */
+      201: {
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemo"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      422: coreComponents["responses"]["ValidationError"];
+    };
+    requestBody: {
+      content: {
+        "application/json": coreComponents["schemas"]["CreditMemo"];
+      };
+    };
+  };
+  /** Void a credit memo with a specified identifier string. */
+  PostCreditMemoVoid: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Credit memo successfully voided . */
+      201: {
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemo"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+    };
+  };
+  /** Retrieve a list of credit memo timeline messages. */
+  GetCreditMemoTimelineCollection: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+      query: {
+        /** The collection items limit. */
+        limit?: coreComponents["parameters"]["collectionLimit"];
+        /** The collection items offset. */
+        offset?: coreComponents["parameters"]["collectionOffset"];
+        /**
+         * The collection items filter requires a special format.
+         * Use "," for multiple allowed values.  Use ";" for multiple fields.
+         * See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
+         */
+        filter?: coreComponents["parameters"]["collectionFilter"];
+        /** The collection items sort field and order (prefix with "-" for descending sort). */
+        sort?: coreComponents["parameters"]["collectionSort"];
+        /** The partial search of the text fields. */
+        q?: coreComponents["parameters"]["collectionQuery"];
+      };
+    };
+    responses: {
+      /** A list of credit memo timeline messages was retrieved successfully. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemoTimeline"][];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+    };
+  };
+  /** Create a credit memo timeline message. */
+  PostCreditMemoTimeline: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Credit memo timeline message was created. */
+      201: {
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemoTimeline"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      422: coreComponents["responses"]["ValidationError"];
+    };
+    /** Credit memo timeline resource. */
+    requestBody: {
+      content: {
+        "application/json": coreComponents["schemas"]["CreditMemoTimeline"];
+      };
+    };
+  };
+  /** Retrieve a credit memo timeline message with specified identifier string. */
+  GetCreditMemoTimeline: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** The credit memo timeline message ID. */
+        messageId: string;
+      };
+    };
+    responses: {
+      /** Credit memo timeline message was retrieved successfully. */
+      200: {
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemoTimeline"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+    };
+  };
+  /** Delete a credit memo timeline message with predefined identifier string. */
+  DeleteCreditMemoTimeline: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** The credit memo timeline message ID. */
+        messageId: string;
+      };
+    };
+    responses: {
+      /** Credit memo timeline message was deleted. */
+      204: never;
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      409: coreComponents["responses"]["Conflict"];
+    };
+  };
+  /** Get the precise amounts from a credit memo allocated to the invoice. */
+  GetInvoiceCreditMemoAllocationCollection: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+      query: {
+        /** The collection items limit. */
+        limit?: coreComponents["parameters"]["collectionLimit"];
+        /** The collection items offset. */
+        offset?: coreComponents["parameters"]["collectionOffset"];
+      };
+    };
+    responses: {
+      /** List of allocations was retrieved successfully. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemoAllocation"][];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+    };
+  };
+  /** Get the allocation from the given credit memo to the given invoice with the credit amount. */
+  GetInvoiceCreditMemoAllocation: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** Credit memo ID. */
+        creditMemoId: string;
+      };
+      query: {
+        /** The collection items limit. */
+        limit?: coreComponents["parameters"]["collectionLimit"];
+        /** The collection items offset. */
+        offset?: coreComponents["parameters"]["collectionOffset"];
+      };
+    };
+    responses: {
+      /** The allocation was retrieved successfully. */
+      200: {
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemoAllocation"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+    };
+  };
+  /** Apply a credit memo to an invoice. The invoice must be unpaid. The credit memo must have a non-zero unused amount (not fully applied to other invoices). */
+  PutInvoiceCreditMemoAllocation: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** Credit memo ID. */
+        creditMemoId: string;
+      };
+    };
+    responses: {
+      /** Credit memo was applied to invoice successfully. */
+      200: {
+        content: {
+          "application/json": coreComponents["schemas"]["CreditMemoAllocation"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      422: coreComponents["responses"]["ValidationError"];
+    };
+    /** CreditMemoAllocation resource. */
+    requestBody: {
+      content: {
+        "application/json": coreComponents["schemas"]["CreditMemoAllocation"];
+      };
+    };
+  };
+  /**
+   * Delete the allocation which is taken from the given credit memo to the given invoice.
+   * Both invoice's and credit memo's total amounts change, possibly with their statuses.
+   */
+  DeleteInvoiceCreditMemoAllocation: {
+    parameters: {
+      path: {
+        /** The resource identifier string. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** Credit memo ID. */
+        creditMemoId: string;
+      };
+    };
+    responses: {
+      /** Invoice's credit memo allocation was deleted. */
+      204: never;
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      409: coreComponents["responses"]["Conflict"];
+    };
+  };
   /** Retrieve a list of KYC requests. */
   GetKycRequestCollection: {
     parameters: {
@@ -13969,6 +14558,20 @@ export interface operations {
       422: coreComponents["responses"]["ValidationError"];
     };
   };
+  /** Retrieve KYC settings. */
+  GetKycSettings: {
+    responses: {
+      /** KYC settings successfully retrieved. */
+      200: {
+        content: {
+          "application/json": coreComponents["schemas"]["KycSettings"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+    };
+  };
   /** Update KYC settings. */
   PutKycSettings: {
     responses: {
@@ -18909,6 +19512,78 @@ export interface usersComponents {
     };
     /** eMerchantPay 3DS Server. */
     eMerchantPay3dsServer: usersComponents["schemas"]["eMerchantPay3dsServers"];
+    /** ThreeDSecureIO3dsServer. */
+    ThreeDSecureIO3dsServer: usersComponents["schemas"]["WorldlineAtosFrankfurt3dsServers"] &
+      usersComponents["schemas"]["TestProcessor3dsServers"] &
+      usersComponents["schemas"]["EMS3dsServers"] & {
+        /** Visa acquirer merchant ID (MID). */
+        acquirerMerchantIdVisa: string;
+        /** Mastercard acquirer merchant ID (MID). */
+        acquirerMerchantIdMastercard: string;
+        /** Merchant Name. */
+        merchantName: string;
+        /** Visa Acquirer BIN. */
+        merchantAcquirerBinVisa: string;
+        /** Mastercard Acquirer BIN. */
+        merchantAcquirerBinMastercard: string;
+        /** Merchant Country ISO Alpha-2 Code. */
+        merchantCountry: string;
+        /** Merchant URL. */
+        merchantUrl: string;
+        /**
+         * Value determines if requests can use version 1 of 3DS.
+         * In case both v1 and v2 are enabled it will prefer v2.
+         * If v2 is not supported for the issuer, it will coalesce to v1.
+         */
+        v1?: boolean;
+        /**
+         * Value determines if requests will attempt version 2 of 3DS.
+         * In case both v1 and v2 are enabled it will prefer v2.
+         * If v2 is not supported for the issuer, it will coalesce to v1.
+         */
+        v2?: boolean;
+        /**
+         * 01 - Goods/Service Purchase
+         * 03 - Check Acceptance
+         * 10 - Account Funding
+         * 11 - Quasi-Cash Transaction
+         * 28 - Prepaid Activation and Load
+         *
+         * Identifies the type of transaction being authenticated.
+         */
+        transactionType?: "01" | "03" | "10" | "11" | "28";
+        /** Set to true to decline transactions if a card is not enrolled instead of continuing without 3DS. */
+        declineNotEnrolled: boolean;
+        /** Use 3DS for merchant initiated transactions. */
+        use3dsForMerchantInitiated: boolean;
+        /**
+         * 01 - Recurring transaction
+         * 02 - Instalment transaction
+         * 03 - Add card
+         * 04 - Maintain card information
+         * 05 - Account verification
+         * 06 - Split/delayed shipment
+         * 07 - Top-up
+         * 08 - Mail Order
+         * 09 - Telephone Order
+         * 10 - Whitelist status check
+         * 11 - Other payment
+         *
+         * Indicates the type of 3RI request. Values 06 - 11 are only supported in 3D2 2.2.0.
+         */
+        threeRIInd?:
+          | "01"
+          | "02"
+          | "03"
+          | "04"
+          | "05"
+          | "06"
+          | "07"
+          | "08"
+          | "09"
+          | "10"
+          | "11";
+      };
     /** The Merchant plug-in Name. */
     ThreeDSecureServerName:
       | "Payvision3dsServer"
@@ -18927,76 +19602,19 @@ export interface usersComponents {
       | "Piastrix3dsServer"
       | "NGenius3dsServer"
       | "Stripe3dsServer";
-    /** ThreeDSecureIO3dsServer. */
-    ThreeDSecureIO3dsServer: {
+    /** WorldlineAtosFrankfurt 3DS Servers. */
+    WorldlineAtosFrankfurt3dsServers: {
+      name: "ThreeDSecureIO3dsServer";
+    };
+    /** TestProcessor3dsServers 3DS Servers. */
+    TestProcessor3dsServers: {
+      name: "TestSandbox3dsServer" | "ThreeDSecureIO3dsServer";
+    };
+    /** TestProcessor Integrated. */
+    TestProcessor3dsServer: usersComponents["schemas"]["TestProcessor3dsServers"];
+    /** EMS 3DS Servers. */
+    EMS3dsServers: {
       name: "ThreeDSecureIO3dsServer";
-      /** Visa acquirer merchant ID (MID). */
-      acquirerMerchantIdVisa: string;
-      /** Mastercard acquirer merchant ID (MID). */
-      acquirerMerchantIdMastercard: string;
-      /** Merchant Name. */
-      merchantName: string;
-      /** Visa Acquirer BIN. */
-      merchantAcquirerBinVisa: string;
-      /** Mastercard Acquirer BIN. */
-      merchantAcquirerBinMastercard: string;
-      /** Merchant Country ISO Alpha-2 Code. */
-      merchantCountry: string;
-      /** Merchant URL. */
-      merchantUrl: string;
-      /**
-       * Value determines if requests can use version 1 of 3DS.
-       * In case both v1 and v2 are enabled it will prefer v2.
-       * If v2 is not supported for the issuer, it will coalesce to v1.
-       */
-      v1?: boolean;
-      /**
-       * Value determines if requests will attempt version 2 of 3DS.
-       * In case both v1 and v2 are enabled it will prefer v2.
-       * If v2 is not supported for the issuer, it will coalesce to v1.
-       */
-      v2?: boolean;
-      /**
-       * 01 - Goods/Service Purchase
-       * 03 - Check Acceptance
-       * 10 - Account Funding
-       * 11 - Quasi-Cash Transaction
-       * 28 - Prepaid Activation and Load
-       *
-       * Identifies the type of transaction being authenticated.
-       */
-      transactionType?: "01" | "03" | "10" | "11" | "28";
-      /** Set to true to decline transactions if a card is not enrolled instead of continuing without 3DS. */
-      declineNotEnrolled: boolean;
-      /** Use 3DS for merchant initiated transactions. */
-      use3dsForMerchantInitiated: boolean;
-      /**
-       * 01 - Recurring transaction
-       * 02 - Instalment transaction
-       * 03 - Add card
-       * 04 - Maintain card information
-       * 05 - Account verification
-       * 06 - Split/delayed shipment
-       * 07 - Top-up
-       * 08 - Mail Order
-       * 09 - Telephone Order
-       * 10 - Whitelist status check
-       * 11 - Other payment
-       *
-       * Indicates the type of 3RI request. Values 06 - 11 are only supported in 3D2 2.2.0.
-       */
-      threeRIInd?:
-        | "01"
-        | "02"
-        | "03"
-        | "04"
-        | "05"
-        | "06"
-        | "07"
-        | "08"
-        | "09"
-        | "10"
-        | "11";
     };
     /** GET 3DS Servers. */
     GET3dsServers: {
@@ -19742,10 +20360,6 @@ export interface usersComponents {
         ssl_pin: string;
       };
     };
-    /** EMS 3DS Servers. */
-    EMS3dsServers: {
-      name: "ThreeDSecureIO3dsServer";
-    };
     /** EMS e-Commerce (XML) API config. */
     EMS: usersComponents["schemas"]["GatewayAccount"] & {
       /** EMS settings object. */
@@ -21173,12 +21787,6 @@ export interface usersComponents {
         transactionDescription?: string;
       };
     };
-    /** TestProcessor3dsServers 3DS Servers. */
-    TestProcessor3dsServers: {
-      name: "TestSandbox3dsServer" | "ThreeDSecureIO3dsServer";
-    };
-    /** TestProcessor Integrated. */
-    TestProcessor3dsServer: usersComponents["schemas"]["TestProcessor3dsServers"];
     /** TestProcessor Gateway config. */
     TestProcessor: usersComponents["schemas"]["GatewayAccount"] & {
       threeDSecureServer?: usersComponents["schemas"]["TestProcessor3dsServers"];
@@ -21367,10 +21975,6 @@ export interface usersComponents {
       };
       threeDSecureServer?: usersComponents["schemas"]["Wirecard3dsServers"];
     };
-    /** WorldlineAtosFrankfurt 3DS Servers. */
-    WorldlineAtosFrankfurt3dsServers: {
-      name: "ThreeDSecureIO3dsServer";
-    };
     /** WorldlineAtosFrankfurt Gateway config. */
     WorldlineAtosFrankfurt: usersComponents["schemas"]["GatewayAccount"] & {
       threeDSecureServer?: usersComponents["schemas"]["WorldlineAtosFrankfurt3dsServers"];
@@ -36137,6 +36741,38 @@ declare module "resources/credential-hashes-resource" {
         }): any;
     };
 }
+declare module "resources/credit-memos-resource" {
+    export default function CreditMemosResource({ apiHandler }: {
+        apiHandler: any;
+    }): {
+        getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetCreditMemoCollectionRequest): rebilly.GetCreditMemoCollectionResponsePromise;
+        create({ id, data }: rebilly.CreateCreditMemoRequest): rebilly.PostCreditMemoResponsePromise;
+        get({ id, expand }: {
+            id: any;
+            expand?: any;
+        }): rebilly.GetCreditMemoResponsePromise;
+        update({ id, data }: {
+            id: any;
+            data: any;
+        }): rebilly.PutCreditMemoResponsePromise;
+        void({ id }: {
+            id: any;
+        }): any;
+        getAllTimelineMessages({ id, limit, offset, filter, sort, q, }: rebilly.GetCreditMemoTimelineCollectionRequest): rebilly.GetCreditMemoTimelineCollectionResponsePromise;
+        createTimelineComment({ id, data }: {
+            id: any;
+            data: any;
+        }): any;
+        getTimelineMessage({ id, messageId }: {
+            id: any;
+            messageId: any;
+        }): rebilly.GetCreditMemoTimelineResponsePromise;
+        deleteTimelineMessage({ id, messageId }: {
+            id: any;
+            messageId: any;
+        }): any;
+    };
+}
 declare module "resources/custom-domains-resource" {
     export default function CustomDomainsResource({ apiHandler }: {
         apiHandler: any;
@@ -36759,6 +37395,22 @@ declare module "resources/invoices-resource" {
             id: any;
             messageId: any;
         }): any;
+        getAllCreditMemoAllocations({ id, limit, offset }: rebilly.GetInvoiceCreditMemoAllocationCollectionRequest): rebilly.GetInvoiceCreditMemoAllocationCollectionResponsePromise;
+        getCreditMemoAllocation({ id, creditMemoId, limit, offset }: {
+            id: any;
+            creditMemoId: any;
+            limit?: any;
+            offset?: any;
+        }): rebilly.GetInvoiceCreditMemoAllocationResponsePromise;
+        applyCreditMemo({ id, creditMemoId, data }: {
+            id: any;
+            creditMemoId: any;
+            data: any;
+        }): rebilly.PutInvoiceCreditMemoAllocationResponsePromise;
+        deleteCreditMemoAllocation({ id, creditMemoId }: {
+            id: any;
+            creditMemoId: any;
+        }): any;
         downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
             limit?: any;
             offset?: any;
@@ -37763,6 +38415,41 @@ declare module "resources/api-instance" {
                 data: any;
             }): any;
         };
+        creditMemos: {
+            getAll({ filter, sort, limit, offset, q, expand, }?: {
+                filter?: string;
+                sort?: string[];
+                limit?: number;
+                offset?: number;
+                q?: string;
+                expand?: string;
+            }): rebilly.GetCreditMemoCollectionResponsePromise;
+            create({ id, data }: rebilly.CreateCreditMemoRequest): rebilly.PostCreditMemoResponsePromise;
+            get({ id, expand }: {
+                id: any;
+                expand?: any;
+            }): rebilly.GetCreditMemoResponsePromise;
+            update({ id, data }: {
+                id: any;
+                data: any;
+            }): rebilly.PutCreditMemoResponsePromise;
+            void({ id }: {
+                id: any;
+            }): any;
+            getAllTimelineMessages({ id, limit, offset, filter, sort, q, }: rebilly.GetCreditMemoTimelineCollectionRequest): rebilly.GetCreditMemoTimelineCollectionResponsePromise;
+            createTimelineComment({ id, data }: {
+                id: any;
+                data: any;
+            }): any;
+            getTimelineMessage({ id, messageId }: {
+                id: any;
+                messageId: any;
+            }): rebilly.GetCreditMemoTimelineResponsePromise;
+            deleteTimelineMessage({ id, messageId }: {
+                id: any;
+                messageId: any;
+            }): any;
+        };
         customDomains: {
             getAll({ limit, offset, sort, filter, q, }?: {
                 limit?: number;
@@ -38401,6 +39088,22 @@ declare module "resources/api-instance" {
                 id: any;
                 messageId: any;
             }): any;
+            getAllCreditMemoAllocations({ id, limit, offset }: rebilly.GetInvoiceCreditMemoAllocationCollectionRequest): rebilly.GetInvoiceCreditMemoAllocationCollectionResponsePromise;
+            getCreditMemoAllocation({ id, creditMemoId, limit, offset }: {
+                id: any;
+                creditMemoId: any;
+                limit?: any;
+                offset?: any;
+            }): rebilly.GetInvoiceCreditMemoAllocationResponsePromise;
+            applyCreditMemo({ id, creditMemoId, data }: {
+                id: any;
+                creditMemoId: any;
+                data: any;
+            }): rebilly.PutInvoiceCreditMemoAllocationResponsePromise;
+            deleteCreditMemoAllocation({ id, creditMemoId }: {
+                id: any;
+                creditMemoId: any;
+            }): any;
             downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
                 limit?: any;
                 offset?: any;