rehive 4.2.2 → 4.3.0

package/src/extensions/mukuru/openapi-ts/types.gen.ts

@@ -0,0 +1,778 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: 'https://mukuru.services.rehive.com/api/' | (string & {});
+};
+
+/**
+ * This serializer can be used if only a `status` is required in the response.
+ */
+export type ActionResponse = {
+    status: string;
+};
+
+/**
+ * Serialize the activation data, should be a token that represents an admin
+ * user.
+ */
+export type Activate = {
+    token: string;
+    readonly id: string;
+    readonly name: string;
+    readonly secret: string;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminCompany = {
+    readonly id: string;
+    readonly secret: string;
+    readonly name: string;
+    /**
+     * * `test` - Test
+     * * `production` - Production
+     */
+    readonly mode: 'test' | 'production';
+    mukuru_keycloak_client_id?: string;
+    mukuru_keycloak_token_url?: string;
+    mukuru_base_url?: string;
+    mukuru_operational_address?: string;
+    /**
+     * * `base` - Base
+     */
+    mukuru_chain?: 'base';
+    readonly configured: boolean;
+};
+
+export type AdminCompanyResponse = {
+    status: string;
+    data: AdminCompany;
+};
+
+/**
+ * Per-company Mukuru payout product, configurable by company admins via
+ * `/api/admin/products/`. Lets clients self-configure their own catalog
+ * (production GUIDs differ per environment) instead of relying on the
+ * `seed_mukuru_products` sandbox management command.
+ *
+ * `company` is never client-supplied — it's taken from the authenticated
+ * admin's company in the view. Uniqueness of (company, payment_method) is
+ * enforced here (cleanly, as a 400) on top of the model's
+ * unique_together, so duplicate POSTs don't surface as a 500.
+ */
+export type AdminMukuruProduct = {
+    payment_method: string;
+    product_guid: string;
+    country_code: string;
+    payout_currency: string;
+    settlement_currency?: string;
+    min_payout_amount?: string | null;
+    max_payout_amount?: string | null;
+    active?: boolean;
+    readonly created: string;
+    readonly updated: string;
+};
+
+export type AdminMukuruProductResponse = {
+    status: string;
+    data: AdminMukuruProduct;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminMukuruTransaction = {
+    readonly id: string;
+    readonly rehive_transaction_id: string;
+    readonly mukuru_external_reference: string;
+    /**
+     * * `pending` - Pending
+     * * `ready` - Ready
+     * * `paid` - Paid
+     * * `received` - Received
+     * * `successful` - Successful
+     * * `cancelled` - Cancelled
+     * * `failed` - Failed
+     * * `kyc_failed` - Kyc Failed
+     * * `insufficient_funds` - Insufficient Funds
+     */
+    readonly mukuru_status: 'pending' | 'ready' | 'paid' | 'received' | 'successful' | 'cancelled' | 'failed' | 'kyc_failed' | 'insufficient_funds';
+    readonly rehive_secondary_status: string;
+    readonly terminated_at: string | null;
+    readonly recipient_mobile: string;
+    readonly created: string;
+    readonly updated: string;
+    readonly mukuru_payload: unknown;
+};
+
+export type AdminMukuruTransactionResponse = {
+    status: string;
+    data: AdminMukuruTransaction;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminUser = {
+    readonly id: string;
+    readonly created: string;
+    readonly updated: string;
+};
+
+/**
+ * Serialize the deactivation data, should be a token that represents an admin
+ * user.
+ */
+export type Deactivate = {
+    token: string;
+    purge?: boolean;
+};
+
+export type PaginatedAdminMukuruProductList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<AdminMukuruProduct>;
+};
+
+export type PaginatedAdminMukuruProductListResponse = {
+    status: string;
+    data: PaginatedAdminMukuruProductList;
+};
+
+export type PaginatedAdminMukuruTransactionList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<AdminMukuruTransaction>;
+};
+
+export type PaginatedAdminMukuruTransactionListResponse = {
+    status: string;
+    data: PaginatedAdminMukuruTransactionList;
+};
+
+export type PaginatedAdminUserList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<AdminUser>;
+};
+
+export type PaginatedAdminUserListResponse = {
+    status: string;
+    data: PaginatedAdminUserList;
+};
+
+export type PaginatedUserMukuruTransactionList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<UserMukuruTransaction>;
+};
+
+export type PaginatedUserMukuruTransactionListResponse = {
+    status: string;
+    data: PaginatedUserMukuruTransactionList;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type PatchedAdminCompany = {
+    readonly id?: string;
+    readonly secret?: string;
+    readonly name?: string;
+    /**
+     * * `test` - Test
+     * * `production` - Production
+     */
+    readonly mode?: 'test' | 'production';
+    mukuru_keycloak_client_id?: string;
+    mukuru_keycloak_token_url?: string;
+    mukuru_base_url?: string;
+    mukuru_operational_address?: string;
+    /**
+     * * `base` - Base
+     */
+    mukuru_chain?: 'base';
+    readonly configured?: boolean;
+};
+
+/**
+ * Per-company Mukuru payout product, configurable by company admins via
+ * `/api/admin/products/`. Lets clients self-configure their own catalog
+ * (production GUIDs differ per environment) instead of relying on the
+ * `seed_mukuru_products` sandbox management command.
+ *
+ * `company` is never client-supplied — it's taken from the authenticated
+ * admin's company in the view. Uniqueness of (company, payment_method) is
+ * enforced here (cleanly, as a 400) on top of the model's
+ * unique_together, so duplicate POSTs don't surface as a 500.
+ */
+export type PatchedAdminMukuruProduct = {
+    payment_method?: string;
+    product_guid?: string;
+    country_code?: string;
+    payout_currency?: string;
+    settlement_currency?: string;
+    min_payout_amount?: string | null;
+    max_payout_amount?: string | null;
+    active?: boolean;
+    readonly created?: string;
+    readonly updated?: string;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type UserMukuruTransaction = {
+    readonly id: string;
+    readonly rehive_transaction_id: string;
+    readonly mukuru_external_reference: string;
+    /**
+     * * `pending` - Pending
+     * * `ready` - Ready
+     * * `paid` - Paid
+     * * `received` - Received
+     * * `successful` - Successful
+     * * `cancelled` - Cancelled
+     * * `failed` - Failed
+     * * `kyc_failed` - Kyc Failed
+     * * `insufficient_funds` - Insufficient Funds
+     */
+    readonly mukuru_status: 'pending' | 'ready' | 'paid' | 'received' | 'successful' | 'cancelled' | 'failed' | 'kyc_failed' | 'insufficient_funds';
+    readonly rehive_secondary_status: string;
+    readonly terminated_at: string | null;
+    readonly recipient_mobile: string;
+    readonly created: string;
+    readonly updated: string;
+};
+
+export type UserMukuruTransactionResponse = {
+    status: string;
+    data: UserMukuruTransaction;
+};
+
+/**
+ * Verifies an inbound Rehive Platform webhook.
+ *
+ * Authenticates by comparing the `Authorization: secret <UUID>` header
+ * against the company's stored secret — the secret we register on each
+ * webhook subscription during activate. Mirrors the canonical pattern
+ * used by service-hifi (serializers.py:332) and service-bridge
+ * (serializers.py:564); see also the plan §"Platform webhook
+ * orchestration".
+ *
+ * Idempotency: PlatformWebhook.identifier is set to Rehive's webhook
+ * delivery UUID, so duplicate deliveries collide on the unique
+ * constraint and become a silent no-op (Rehive retries on non-2xx).
+ */
+export type Webhook = {
+    id: string;
+    /**
+     * * `transaction.update` - Transaction Update
+     * * `transaction.initiate` - Transaction Initiate
+     * * `transaction.transition.update` - Transaction Transition Update
+     * * `user.update` - User Update
+     * * `wallet_account.create` - Wallet Account Create
+     * * `wallet_account.update` - Wallet Account Update
+     * * `wallet_account.delete` - Wallet Account Delete
+     */
+    event: 'transaction.update' | 'transaction.initiate' | 'transaction.transition.update' | 'user.update' | 'wallet_account.create' | 'wallet_account.update' | 'wallet_account.delete';
+    company: string;
+    data: unknown;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminCompanyWritable = {
+    mukuru_keycloak_client_id?: string;
+    mukuru_keycloak_client_secret?: string;
+    mukuru_keycloak_token_url?: string;
+    mukuru_base_url?: string;
+    mukuru_operational_address?: string;
+    /**
+     * * `base` - Base
+     */
+    mukuru_chain?: 'base';
+    mukuru_callback_password?: string;
+};
+
+export type AdminCompanyResponseWritable = {
+    status: string;
+    data: AdminCompanyWritable;
+};
+
+/**
+ * Per-company Mukuru payout product, configurable by company admins via
+ * `/api/admin/products/`. Lets clients self-configure their own catalog
+ * (production GUIDs differ per environment) instead of relying on the
+ * `seed_mukuru_products` sandbox management command.
+ *
+ * `company` is never client-supplied — it's taken from the authenticated
+ * admin's company in the view. Uniqueness of (company, payment_method) is
+ * enforced here (cleanly, as a 400) on top of the model's
+ * unique_together, so duplicate POSTs don't surface as a 500.
+ */
+export type AdminMukuruProductWritable = {
+    payment_method: string;
+    product_guid: string;
+    country_code: string;
+    payout_currency: string;
+    settlement_currency?: string;
+    min_payout_amount?: string | null;
+    max_payout_amount?: string | null;
+    active?: boolean;
+};
+
+export type AdminMukuruProductResponseWritable = {
+    status: string;
+    data: AdminMukuruProductWritable;
+};
+
+export type AdminMukuruTransactionResponseWritable = {
+    status: string;
+};
+
+export type PaginatedAdminMukuruProductListWritable = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<AdminMukuruProductWritable>;
+};
+
+export type PaginatedAdminMukuruProductListResponseWritable = {
+    status: string;
+    data: PaginatedAdminMukuruProductListWritable;
+};
+
+export type PaginatedAdminMukuruTransactionListWritable = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<unknown>;
+};
+
+export type PaginatedAdminMukuruTransactionListResponseWritable = {
+    status: string;
+    data: PaginatedAdminMukuruTransactionListWritable;
+};
+
+export type PaginatedAdminUserListWritable = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<unknown>;
+};
+
+export type PaginatedAdminUserListResponseWritable = {
+    status: string;
+    data: PaginatedAdminUserListWritable;
+};
+
+export type PaginatedUserMukuruTransactionListWritable = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<unknown>;
+};
+
+export type PaginatedUserMukuruTransactionListResponseWritable = {
+    status: string;
+    data: PaginatedUserMukuruTransactionListWritable;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type PatchedAdminCompanyWritable = {
+    mukuru_keycloak_client_id?: string;
+    mukuru_keycloak_client_secret?: string;
+    mukuru_keycloak_token_url?: string;
+    mukuru_base_url?: string;
+    mukuru_operational_address?: string;
+    /**
+     * * `base` - Base
+     */
+    mukuru_chain?: 'base';
+    mukuru_callback_password?: string;
+};
+
+/**
+ * Per-company Mukuru payout product, configurable by company admins via
+ * `/api/admin/products/`. Lets clients self-configure their own catalog
+ * (production GUIDs differ per environment) instead of relying on the
+ * `seed_mukuru_products` sandbox management command.
+ *
+ * `company` is never client-supplied — it's taken from the authenticated
+ * admin's company in the view. Uniqueness of (company, payment_method) is
+ * enforced here (cleanly, as a 400) on top of the model's
+ * unique_together, so duplicate POSTs don't surface as a 500.
+ */
+export type PatchedAdminMukuruProductWritable = {
+    payment_method?: string;
+    product_guid?: string;
+    country_code?: string;
+    payout_currency?: string;
+    settlement_currency?: string;
+    min_payout_amount?: string | null;
+    max_payout_amount?: string | null;
+    active?: boolean;
+};
+
+export type UserMukuruTransactionResponseWritable = {
+    status: string;
+};
+
+export type ActivateCreateData = {
+    body: Activate;
+    path?: never;
+    query?: never;
+    url: '/activate/';
+};
+
+export type ActivateCreateResponses = {
+    200: ActionResponse;
+};
+
+export type ActivateCreateResponse = ActivateCreateResponses[keyof ActivateCreateResponses];
+
+export type AdminCompanyRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+
+export type AdminCompanyRetrieveResponses = {
+    200: AdminCompanyResponse;
+};
+
+export type AdminCompanyRetrieveResponse = AdminCompanyRetrieveResponses[keyof AdminCompanyRetrieveResponses];
+
+export type AdminCompanyPartialUpdateData = {
+    body?: PatchedAdminCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+
+export type AdminCompanyPartialUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+
+export type AdminCompanyPartialUpdateResponse = AdminCompanyPartialUpdateResponses[keyof AdminCompanyPartialUpdateResponses];
+
+export type AdminCompanyUpdateData = {
+    body?: AdminCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+
+export type AdminCompanyUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+
+export type AdminCompanyUpdateResponse = AdminCompanyUpdateResponses[keyof AdminCompanyUpdateResponses];
+
+export type AdminProductsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+    };
+    url: '/admin/products/';
+};
+
+export type AdminProductsListResponses = {
+    200: PaginatedAdminMukuruProductListResponse;
+};
+
+export type AdminProductsListResponse = AdminProductsListResponses[keyof AdminProductsListResponses];
+
+export type AdminProductsCreateData = {
+    body: AdminMukuruProductWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/products/';
+};
+
+export type AdminProductsCreateResponses = {
+    201: AdminMukuruProductResponse;
+};
+
+export type AdminProductsCreateResponse = AdminProductsCreateResponses[keyof AdminProductsCreateResponses];
+
+export type AdminProductsDestroyData = {
+    body?: never;
+    path: {
+        payment_method: string;
+    };
+    query?: never;
+    url: '/admin/products/{payment_method}/';
+};
+
+export type AdminProductsDestroyResponses = {
+    200: AdminMukuruProductResponse;
+};
+
+export type AdminProductsDestroyResponse = AdminProductsDestroyResponses[keyof AdminProductsDestroyResponses];
+
+export type AdminProductsRetrieveData = {
+    body?: never;
+    path: {
+        payment_method: string;
+    };
+    query?: never;
+    url: '/admin/products/{payment_method}/';
+};
+
+export type AdminProductsRetrieveResponses = {
+    200: AdminMukuruProductResponse;
+};
+
+export type AdminProductsRetrieveResponse = AdminProductsRetrieveResponses[keyof AdminProductsRetrieveResponses];
+
+export type AdminProductsPartialUpdateData = {
+    body?: PatchedAdminMukuruProductWritable;
+    path: {
+        payment_method: string;
+    };
+    query?: never;
+    url: '/admin/products/{payment_method}/';
+};
+
+export type AdminProductsPartialUpdateResponses = {
+    200: AdminMukuruProductResponse;
+};
+
+export type AdminProductsPartialUpdateResponse = AdminProductsPartialUpdateResponses[keyof AdminProductsPartialUpdateResponses];
+
+export type AdminProductsUpdateData = {
+    body: AdminMukuruProductWritable;
+    path: {
+        payment_method: string;
+    };
+    query?: never;
+    url: '/admin/products/{payment_method}/';
+};
+
+export type AdminProductsUpdateResponses = {
+    200: AdminMukuruProductResponse;
+};
+
+export type AdminProductsUpdateResponse = AdminProductsUpdateResponses[keyof AdminProductsUpdateResponses];
+
+export type AdminTransactionsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+    };
+    url: '/admin/transactions/';
+};
+
+export type AdminTransactionsListResponses = {
+    200: PaginatedAdminMukuruTransactionListResponse;
+};
+
+export type AdminTransactionsListResponse = AdminTransactionsListResponses[keyof AdminTransactionsListResponses];
+
+export type AdminTransactionsRetrieveData = {
+    body?: never;
+    path: {
+        rehive_transaction_id: string;
+    };
+    query?: never;
+    url: '/admin/transactions/{rehive_transaction_id}/';
+};
+
+export type AdminTransactionsRetrieveResponses = {
+    200: AdminMukuruTransactionResponse;
+};
+
+export type AdminTransactionsRetrieveResponse = AdminTransactionsRetrieveResponses[keyof AdminTransactionsRetrieveResponses];
+
+export type AdminTransactionsRefreshStatusCreateData = {
+    body?: never;
+    path: {
+        rehive_transaction_id: string;
+    };
+    query?: never;
+    url: '/admin/transactions/{rehive_transaction_id}/refresh-status/';
+};
+
+export type AdminTransactionsRefreshStatusCreateResponses = {
+    /**
+     * No response body
+     */
+    200: unknown;
+};
+
+export type AdminUsersListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+    };
+    url: '/admin/users/';
+};
+
+export type AdminUsersListResponses = {
+    200: PaginatedAdminUserListResponse;
+};
+
+export type AdminUsersListResponse = AdminUsersListResponses[keyof AdminUsersListResponses];
+
+export type DeactivateCreateData = {
+    body: Deactivate;
+    path?: never;
+    query?: never;
+    url: '/deactivate/';
+};
+
+export type DeactivateCreateResponses = {
+    200: ActionResponse;
+};
+
+export type DeactivateCreateResponse = DeactivateCreateResponses[keyof DeactivateCreateResponses];
+
+export type MukuruCallbackCreateData = {
+    body?: never;
+    path: {
+        company_identifier: string;
+    };
+    query?: never;
+    url: '/mukuru/callback/{company_identifier}/';
+};
+
+export type MukuruCallbackCreateResponses = {
+    /**
+     * No response body
+     */
+    200: unknown;
+};
+
+export type UserCatalogsRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/user/catalogs/';
+};
+
+export type UserCatalogsRetrieveResponses = {
+    /**
+     * No response body
+     */
+    200: unknown;
+};
+
+export type UserQuoteCreateData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/user/quote/';
+};
+
+export type UserQuoteCreateResponses = {
+    /**
+     * No response body
+     */
+    200: unknown;
+};
+
+export type UserTransactionsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+    };
+    url: '/user/transactions/';
+};
+
+export type UserTransactionsListResponses = {
+    200: PaginatedUserMukuruTransactionListResponse;
+};
+
+export type UserTransactionsListResponse = UserTransactionsListResponses[keyof UserTransactionsListResponses];
+
+export type UserTransactionsRetrieveData = {
+    body?: never;
+    path: {
+        rehive_transaction_id: string;
+    };
+    query?: never;
+    url: '/user/transactions/{rehive_transaction_id}/';
+};
+
+export type UserTransactionsRetrieveResponses = {
+    200: UserMukuruTransactionResponse;
+};
+
+export type UserTransactionsRetrieveResponse = UserTransactionsRetrieveResponses[keyof UserTransactionsRetrieveResponses];
+
+export type WebhookCreateData = {
+    body: Webhook;
+    path?: never;
+    query?: never;
+    url: '/webhook/';
+};
+
+export type WebhookCreateResponses = {
+    200: ActionResponse;
+};
+
+export type WebhookCreateResponse = WebhookCreateResponses[keyof WebhookCreateResponses];