camara-sdk 0.1.1

package/resources/knowyourcustomerageverification.d.ts

@@ -0,0 +1,168 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Knowyourcustomerageverification extends APIResource {
+    /**
+     * Verify that the age of the subscriber associated with a phone number is equal to
+     * or greater than the specified age threshold value.
+     *
+     * As it is possible that the person holding the contract and the end-user of the
+     * subscription may not be the same, the endpoint also admits a list of optional
+     * properties to be included in the request to improve the identification. The
+     * response may optionally include the `identityMatchScore` property with a value
+     * that indicates how certain it is that the information returned relates to the
+     * person that the API Client is requesting. To increase the reliability of the
+     * information returned, the API Provider may include in the response the
+     * `verifiedStatus` property, indicating whether the identity information in its
+     * possession has been verified against an identification document legally accepted
+     * as an age verification document (Note). Note: Depending on the country,
+     * credit-check or other mechanism can be used instead of official identification
+     * for Age Verification. For details, please contact API Provider.
+     *
+     * If the API Client indicates request properties `includeContentLock` or
+     * `includeParentalControl` with value `true` and the API Provider implements this
+     * functionality, then the response will also include `contentLock` and
+     * `parentalControl` properties to indicate if the subscription has any kind of
+     * content filtering enabled. On the other hand, if the request properties are not
+     * included or the API Client specifies value `false`, then the response properties
+     * will not be returned. If the API Provider doesn't implement this functionality,
+     * request properties will be ignored and response properties won't be returned in
+     * any case.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.knowyourcustomerageverification.verify({
+     *     ageThreshold: 18,
+     *     birthdate: '1978-08-22',
+     *     email: 'federicaSanchez.Arjona@example.com',
+     *     familyName: 'Sanchez Arjona',
+     *     familyNameAtBirth: 'YYYY',
+     *     givenName: 'Federica',
+     *     idDocument: '66666666q',
+     *     includeContentLock: true,
+     *     includeParentalControl: true,
+     *     middleNames: 'Sanchez',
+     *     name: 'Federica Sanchez Arjona',
+     *     phoneNumber: '+34629255833',
+     *   });
+     * ```
+     */
+    verify(params: KnowyourcustomerageverificationVerifyParams, options?: RequestOptions): APIPromise<KnowyourcustomerageverificationVerifyResponse>;
+}
+/**
+ * Response to an age verification request
+ */
+export interface KnowyourcustomerageverificationVerifyResponse {
+    /**
+     * Indicate `"true"` when the age of the user is the same age or older than the age
+     * threshold (age >= age threshold), and `"false"` if not (age < age threshold). If
+     * the API Provider doesn't have enough information to perform the validation, a
+     * `not_available` can be returned.
+     */
+    ageCheck: 'true' | 'false' | 'not_available';
+    /**
+     * Indicate `"true"` if the subscription associated with the phone number has any
+     * kind of content lock (i.e certain web content blocked) and `"false"` if not. If
+     * the information is not available the value `not_available` can be returned.
+     */
+    contentLock?: 'true' | 'false' | 'not_available';
+    /**
+     * The overall score of identity information available in the API Provider,
+     * information either provided in the request body comparing it to the one that the
+     * API Provider holds or directly using internal API Provider's information. It is
+     * optional for the API Provider to return the Identity match score.
+     */
+    identityMatchScore?: number;
+    /**
+     * Indicate `"true"` if the subscription associated with the phone number has any
+     * kind of parental control activated and `"false"` if not. If the information is
+     * not available the value `not_available` can be returned.
+     */
+    parentalControl?: 'true' | 'false' | 'not_available';
+    /**
+     * Indicate `true` if the information provided has been compared against
+     * information based on an identification document legally accepted as an age
+     * verification document (Note), otherwise indicate `false`. Note: Depending on the
+     * country, credit-check or other mechanism can be used instead of official
+     * identification for Age Verification. For details, please contact API Provider.
+     */
+    verifiedStatus?: boolean;
+}
+export interface KnowyourcustomerageverificationVerifyParams {
+    /**
+     * Body param: The age to be verified. The indicated range is a global definition
+     * of maximum and minimum values allowed to be requested. It is important to note
+     * that this range might be more restrictive in some implementations due to local
+     * regulations of a country i.e. A country does not allow to request for an age
+     * under 18. This limitation must be informed during the onboarding process.
+     */
+    ageThreshold: number;
+    /**
+     * Body param: The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date
+     * format (YYYY-MM-DD).
+     */
+    birthdate?: string;
+    /**
+     * Body param: Email address of the customer in the RFC specified format
+     * (local-part@domain).
+     */
+    email?: string;
+    /**
+     * Body param: Last name, family name, or surname of the customer.
+     */
+    familyName?: string;
+    /**
+     * Body param: Last/family/sur- name at birth of the customer.
+     */
+    familyNameAtBirth?: string;
+    /**
+     * Body param: First/given name or compound first/given name of the customer.
+     */
+    givenName?: string;
+    /**
+     * Body param: Id number associated to the official identity document in the
+     * country. It may contain alphanumeric characters.
+     */
+    idDocument?: string;
+    /**
+     * Body param: If this parameter is included in the request with value `true`, the
+     * response property `contentLock` will be returned. If it is not included or its
+     * value is `false`, the response property will not be returned.
+     */
+    includeContentLock?: boolean;
+    /**
+     * Body param: If this parameter is included in the request with value `true`, the
+     * response property `parentalControl` will be returned. If it is not included or
+     * its value is `false`, the response property will not be returned.
+     */
+    includeParentalControl?: boolean;
+    /**
+     * Body param: Middle name/s of the customer.
+     */
+    middleNames?: string;
+    /**
+     * Body param: Complete name of the customer, usually composed of first/given name
+     * and last/family/sur- name in a country. Depending on the country, the order of
+     * first/give name and last/family/sur- name varies, and middle name could be
+     * included. It can use givenName, middleNames, familyName and/or
+     * familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be
+     * name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+     */
+    name?: string;
+    /**
+     * Body param: A public identifier addressing a telephone subscription. In mobile
+     * networks it corresponds to the MSISDN (Mobile Station International Subscriber
+     * Directory Number). In order to be globally unique it has to be formatted in
+     * international format, according to E.164 standard, prefixed with '+'.
+     */
+    phoneNumber?: string;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export declare namespace Knowyourcustomerageverification {
+    export { type KnowyourcustomerageverificationVerifyResponse as KnowyourcustomerageverificationVerifyResponse, type KnowyourcustomerageverificationVerifyParams as KnowyourcustomerageverificationVerifyParams, };
+}
+//# sourceMappingURL=knowyourcustomerageverification.d.ts.map

package/resources/knowyourcustomerageverification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowyourcustomerageverification.d.ts","sourceRoot":"","sources":["../src/resources/knowyourcustomerageverification.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,+BAAgC,SAAQ,WAAW;IAC9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CACJ,MAAM,EAAE,2CAA2C,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6CAA6C,CAAC;CAW7D;AAED;;GAEG;AACH,MAAM,WAAW,6CAA6C;IAC5D;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,eAAe,CAAC;IAE7C;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,eAAe,CAAC;IAEjD;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,eAAe,CAAC;IAErD;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,2CAA2C;IAC1D;;;;;;OAMG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,+BAA+B,CAAC;IACvD,OAAO,EACL,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,2CAA2C,IAAI,2CAA2C,GAChG,CAAC;CACH"}

package/resources/knowyourcustomerageverification.js

@@ -0,0 +1,67 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Knowyourcustomerageverification = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+class Knowyourcustomerageverification extends resource_1.APIResource {
+    /**
+     * Verify that the age of the subscriber associated with a phone number is equal to
+     * or greater than the specified age threshold value.
+     *
+     * As it is possible that the person holding the contract and the end-user of the
+     * subscription may not be the same, the endpoint also admits a list of optional
+     * properties to be included in the request to improve the identification. The
+     * response may optionally include the `identityMatchScore` property with a value
+     * that indicates how certain it is that the information returned relates to the
+     * person that the API Client is requesting. To increase the reliability of the
+     * information returned, the API Provider may include in the response the
+     * `verifiedStatus` property, indicating whether the identity information in its
+     * possession has been verified against an identification document legally accepted
+     * as an age verification document (Note). Note: Depending on the country,
+     * credit-check or other mechanism can be used instead of official identification
+     * for Age Verification. For details, please contact API Provider.
+     *
+     * If the API Client indicates request properties `includeContentLock` or
+     * `includeParentalControl` with value `true` and the API Provider implements this
+     * functionality, then the response will also include `contentLock` and
+     * `parentalControl` properties to indicate if the subscription has any kind of
+     * content filtering enabled. On the other hand, if the request properties are not
+     * included or the API Client specifies value `false`, then the response properties
+     * will not be returned. If the API Provider doesn't implement this functionality,
+     * request properties will be ignored and response properties won't be returned in
+     * any case.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.knowyourcustomerageverification.verify({
+     *     ageThreshold: 18,
+     *     birthdate: '1978-08-22',
+     *     email: 'federicaSanchez.Arjona@example.com',
+     *     familyName: 'Sanchez Arjona',
+     *     familyNameAtBirth: 'YYYY',
+     *     givenName: 'Federica',
+     *     idDocument: '66666666q',
+     *     includeContentLock: true,
+     *     includeParentalControl: true,
+     *     middleNames: 'Sanchez',
+     *     name: 'Federica Sanchez Arjona',
+     *     phoneNumber: '+34629255833',
+     *   });
+     * ```
+     */
+    verify(params, options) {
+        const { 'x-correlator': xCorrelator, ...body } = params;
+        return this._client.post('/knowyourcustomerageverification/verify', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Knowyourcustomerageverification = Knowyourcustomerageverification;
+//# sourceMappingURL=knowyourcustomerageverification.js.map

package/resources/knowyourcustomerageverification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowyourcustomerageverification.js","sourceRoot":"","sources":["../src/resources/knowyourcustomerageverification.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAGnD,MAAa,+BAAgC,SAAQ,sBAAW;IAC9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CACJ,MAAmD,EACnD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE;YAClE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA7DD,0EA6DC"}

package/resources/knowyourcustomerageverification.mjs

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+export class Knowyourcustomerageverification extends APIResource {
+    /**
+     * Verify that the age of the subscriber associated with a phone number is equal to
+     * or greater than the specified age threshold value.
+     *
+     * As it is possible that the person holding the contract and the end-user of the
+     * subscription may not be the same, the endpoint also admits a list of optional
+     * properties to be included in the request to improve the identification. The
+     * response may optionally include the `identityMatchScore` property with a value
+     * that indicates how certain it is that the information returned relates to the
+     * person that the API Client is requesting. To increase the reliability of the
+     * information returned, the API Provider may include in the response the
+     * `verifiedStatus` property, indicating whether the identity information in its
+     * possession has been verified against an identification document legally accepted
+     * as an age verification document (Note). Note: Depending on the country,
+     * credit-check or other mechanism can be used instead of official identification
+     * for Age Verification. For details, please contact API Provider.
+     *
+     * If the API Client indicates request properties `includeContentLock` or
+     * `includeParentalControl` with value `true` and the API Provider implements this
+     * functionality, then the response will also include `contentLock` and
+     * `parentalControl` properties to indicate if the subscription has any kind of
+     * content filtering enabled. On the other hand, if the request properties are not
+     * included or the API Client specifies value `false`, then the response properties
+     * will not be returned. If the API Provider doesn't implement this functionality,
+     * request properties will be ignored and response properties won't be returned in
+     * any case.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.knowyourcustomerageverification.verify({
+     *     ageThreshold: 18,
+     *     birthdate: '1978-08-22',
+     *     email: 'federicaSanchez.Arjona@example.com',
+     *     familyName: 'Sanchez Arjona',
+     *     familyNameAtBirth: 'YYYY',
+     *     givenName: 'Federica',
+     *     idDocument: '66666666q',
+     *     includeContentLock: true,
+     *     includeParentalControl: true,
+     *     middleNames: 'Sanchez',
+     *     name: 'Federica Sanchez Arjona',
+     *     phoneNumber: '+34629255833',
+     *   });
+     * ```
+     */
+    verify(params, options) {
+        const { 'x-correlator': xCorrelator, ...body } = params;
+        return this._client.post('/knowyourcustomerageverification/verify', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(xCorrelator != null ? { 'x-correlator': xCorrelator } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=knowyourcustomerageverification.mjs.map

package/resources/knowyourcustomerageverification.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowyourcustomerageverification.mjs","sourceRoot":"","sources":["../src/resources/knowyourcustomerageverification.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,+BAAgC,SAAQ,WAAW;IAC9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CACJ,MAAmD,EACnD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yCAAyC,EAAE;YAClE,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBAC1E,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/knowyourcustomerfill-in.d.mts

@@ -0,0 +1,165 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class KnowyourcustomerfillIn extends APIResource {
+    /**
+     * Providing information related to a customer identity stored the account data
+     * bound to the customer's phone number.
+     *
+     * @example
+     * ```ts
+     * const knowyourcustomerfillIn =
+     *   await client.knowyourcustomerfillIn.create({
+     *     phoneNumber: '+34629255833',
+     *   });
+     * ```
+     */
+    create(params?: KnowyourcustomerfillInCreateParams | null | undefined, options?: RequestOptions): APIPromise<KnowyourcustomerfillInCreateResponse>;
+}
+export interface KnowyourcustomerfillInCreateResponse {
+    /**
+     * Complete address of the customer stored on the Operator's system. For some
+     * countries, it is built following the usual concatenation of parameters in a
+     * country, but for other countries, this is not the case. For some countries, it
+     * can use streetName, streetNumber and/or houseNumberExtension. For example, in
+     * ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or
+     * streetName+streetNumber+houseNumberExtension.
+     */
+    address?: string;
+    /**
+     * Birthdate of the customer, in ISO 8601 calendar date format (YYYY-MM-DD), stored
+     * on the Operator's system.
+     */
+    birthdate?: string;
+    /**
+     * City where the customer was born.
+     */
+    cityOfBirth?: string;
+    /**
+     * Country of the customer's address stored on the Operator's system. Format ISO
+     * 3166-1 alpha-2.
+     */
+    country?: string;
+    /**
+     * Country where the customer was born. Format ISO 3166-1 alpha-2.
+     */
+    countryOfBirth?: string;
+    /**
+     * Email address of the customer in the RFC specified format (local-part@domain),
+     * stored on the Operator's system.
+     */
+    email?: string;
+    /**
+     * Last name, family name, or surname of the customer stored on the Operator's
+     * system.
+     */
+    familyName?: string;
+    /**
+     * Last/family/sur- name at birth of the customer stored on the Operator's system.
+     */
+    familyNameAtBirth?: string;
+    /**
+     * Gender of the customer stored on the Operator's system (Male/Female/Other).
+     */
+    gender?: 'MALE' | 'FEMALE' | 'OTHER';
+    /**
+     * First/given name or compound first/given name of the customer on the Operator's
+     * system.
+     */
+    givenName?: string;
+    /**
+     * House number extension of the customer stored on the Operator's system. Specific
+     * identifier of the house needed depending on the property type. For example,
+     * number of apartment in an apartment building.
+     */
+    houseNumberExtension?: string;
+    /**
+     * Id number associated to the id_document of the customer stored on the Operator's
+     * system.
+     */
+    idDocument?: string;
+    /**
+     * Expiration date of the identity document (ISO 8601).
+     */
+    idDocumentExpiryDate?: string;
+    /**
+     * Type of the official identity document provided.
+     */
+    idDocumentType?: 'passport' | 'national_id_card' | 'residence_permit' | 'diplomatic_id' | 'driver_licence' | 'social_security_id' | 'other';
+    /**
+     * Locality of the customer's address, stored on the Operator's system.
+     */
+    locality?: string;
+    /**
+     * Middle name/s of the customer stored on the Operator's system.
+     */
+    middleNames?: string;
+    /**
+     * Complete name of the customer stored on the Operator's system. It is usually
+     * composed of first/given name and last/family/sur- name in a country. Depending
+     * on the country, the order of first/give name and last/family/sur- name varies,
+     * and middle name could be included. It can use givenName, middleNames, familyName
+     * and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can
+     * be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+     */
+    name?: string;
+    /**
+     * Complete name of the customer in Hankaku-Kana format (reading of name) for
+     * Japan, stored on the Operator's system.
+     */
+    nameKanaHankaku?: string;
+    /**
+     * Complete name of the customer in Zenkaku-Kana format (reading of name) for
+     * Japan, stored on the Operator's system.
+     */
+    nameKanaZenkaku?: string;
+    /**
+     * ISO 3166-1 alpha-2 code of the customer’s nationality. In the case a customer
+     * has more than one nationality, it is supposed to be the nationality related to
+     * the ID document provided in the match request.
+     */
+    nationality?: string;
+    /**
+     * A public identifier addressing a telephone subscription. In mobile networks it
+     * corresponds to the MSISDN (Mobile Station International Subscriber Directory
+     * Number). In order to be globally unique it has to be formatted in international
+     * format, according to E.164 standard, prefixed with '+'.
+     */
+    phoneNumber?: string;
+    /**
+     * The postal code or Zip code of the customer's address, stored on the Operator's
+     * system.
+     */
+    postalCode?: string;
+    /**
+     * Region/prefecture of the customer's address, stored on the Operator's system.
+     */
+    region?: string;
+    /**
+     * Name of the street of the customer's address on the Operator's system. It should
+     * not include the type of the street.
+     */
+    streetName?: string;
+    /**
+     * The street number of the customer's address on the Operator's system. Number
+     * identifying a specific property on the 'streetName'.
+     */
+    streetNumber?: string;
+}
+export interface KnowyourcustomerfillInCreateParams {
+    /**
+     * Body param: A public identifier addressing a telephone subscription. In mobile
+     * networks it corresponds to the MSISDN (Mobile Station International Subscriber
+     * Directory Number). In order to be globally unique it has to be formatted in
+     * international format, according to E.164 standard, prefixed with '+'.
+     */
+    phoneNumber?: string;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export declare namespace KnowyourcustomerfillIn {
+    export { type KnowyourcustomerfillInCreateResponse as KnowyourcustomerfillInCreateResponse, type KnowyourcustomerfillInCreateParams as KnowyourcustomerfillInCreateParams, };
+}
+//# sourceMappingURL=knowyourcustomerfill-in.d.mts.map

package/resources/knowyourcustomerfill-in.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowyourcustomerfill-in.d.mts","sourceRoot":"","sources":["../src/resources/knowyourcustomerfill-in.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAWpD;AAED,MAAM,WAAW,oCAAoC;IACnD;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IAErC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EACX,UAAU,GACV,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,oBAAoB,GACpB,OAAO,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}

package/resources/knowyourcustomerfill-in.d.ts

@@ -0,0 +1,165 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class KnowyourcustomerfillIn extends APIResource {
+    /**
+     * Providing information related to a customer identity stored the account data
+     * bound to the customer's phone number.
+     *
+     * @example
+     * ```ts
+     * const knowyourcustomerfillIn =
+     *   await client.knowyourcustomerfillIn.create({
+     *     phoneNumber: '+34629255833',
+     *   });
+     * ```
+     */
+    create(params?: KnowyourcustomerfillInCreateParams | null | undefined, options?: RequestOptions): APIPromise<KnowyourcustomerfillInCreateResponse>;
+}
+export interface KnowyourcustomerfillInCreateResponse {
+    /**
+     * Complete address of the customer stored on the Operator's system. For some
+     * countries, it is built following the usual concatenation of parameters in a
+     * country, but for other countries, this is not the case. For some countries, it
+     * can use streetName, streetNumber and/or houseNumberExtension. For example, in
+     * ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or
+     * streetName+streetNumber+houseNumberExtension.
+     */
+    address?: string;
+    /**
+     * Birthdate of the customer, in ISO 8601 calendar date format (YYYY-MM-DD), stored
+     * on the Operator's system.
+     */
+    birthdate?: string;
+    /**
+     * City where the customer was born.
+     */
+    cityOfBirth?: string;
+    /**
+     * Country of the customer's address stored on the Operator's system. Format ISO
+     * 3166-1 alpha-2.
+     */
+    country?: string;
+    /**
+     * Country where the customer was born. Format ISO 3166-1 alpha-2.
+     */
+    countryOfBirth?: string;
+    /**
+     * Email address of the customer in the RFC specified format (local-part@domain),
+     * stored on the Operator's system.
+     */
+    email?: string;
+    /**
+     * Last name, family name, or surname of the customer stored on the Operator's
+     * system.
+     */
+    familyName?: string;
+    /**
+     * Last/family/sur- name at birth of the customer stored on the Operator's system.
+     */
+    familyNameAtBirth?: string;
+    /**
+     * Gender of the customer stored on the Operator's system (Male/Female/Other).
+     */
+    gender?: 'MALE' | 'FEMALE' | 'OTHER';
+    /**
+     * First/given name or compound first/given name of the customer on the Operator's
+     * system.
+     */
+    givenName?: string;
+    /**
+     * House number extension of the customer stored on the Operator's system. Specific
+     * identifier of the house needed depending on the property type. For example,
+     * number of apartment in an apartment building.
+     */
+    houseNumberExtension?: string;
+    /**
+     * Id number associated to the id_document of the customer stored on the Operator's
+     * system.
+     */
+    idDocument?: string;
+    /**
+     * Expiration date of the identity document (ISO 8601).
+     */
+    idDocumentExpiryDate?: string;
+    /**
+     * Type of the official identity document provided.
+     */
+    idDocumentType?: 'passport' | 'national_id_card' | 'residence_permit' | 'diplomatic_id' | 'driver_licence' | 'social_security_id' | 'other';
+    /**
+     * Locality of the customer's address, stored on the Operator's system.
+     */
+    locality?: string;
+    /**
+     * Middle name/s of the customer stored on the Operator's system.
+     */
+    middleNames?: string;
+    /**
+     * Complete name of the customer stored on the Operator's system. It is usually
+     * composed of first/given name and last/family/sur- name in a country. Depending
+     * on the country, the order of first/give name and last/family/sur- name varies,
+     * and middle name could be included. It can use givenName, middleNames, familyName
+     * and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can
+     * be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.
+     */
+    name?: string;
+    /**
+     * Complete name of the customer in Hankaku-Kana format (reading of name) for
+     * Japan, stored on the Operator's system.
+     */
+    nameKanaHankaku?: string;
+    /**
+     * Complete name of the customer in Zenkaku-Kana format (reading of name) for
+     * Japan, stored on the Operator's system.
+     */
+    nameKanaZenkaku?: string;
+    /**
+     * ISO 3166-1 alpha-2 code of the customer’s nationality. In the case a customer
+     * has more than one nationality, it is supposed to be the nationality related to
+     * the ID document provided in the match request.
+     */
+    nationality?: string;
+    /**
+     * A public identifier addressing a telephone subscription. In mobile networks it
+     * corresponds to the MSISDN (Mobile Station International Subscriber Directory
+     * Number). In order to be globally unique it has to be formatted in international
+     * format, according to E.164 standard, prefixed with '+'.
+     */
+    phoneNumber?: string;
+    /**
+     * The postal code or Zip code of the customer's address, stored on the Operator's
+     * system.
+     */
+    postalCode?: string;
+    /**
+     * Region/prefecture of the customer's address, stored on the Operator's system.
+     */
+    region?: string;
+    /**
+     * Name of the street of the customer's address on the Operator's system. It should
+     * not include the type of the street.
+     */
+    streetName?: string;
+    /**
+     * The street number of the customer's address on the Operator's system. Number
+     * identifying a specific property on the 'streetName'.
+     */
+    streetNumber?: string;
+}
+export interface KnowyourcustomerfillInCreateParams {
+    /**
+     * Body param: A public identifier addressing a telephone subscription. In mobile
+     * networks it corresponds to the MSISDN (Mobile Station International Subscriber
+     * Directory Number). In order to be globally unique it has to be formatted in
+     * international format, according to E.164 standard, prefixed with '+'.
+     */
+    phoneNumber?: string;
+    /**
+     * Header param: Correlation id for the different services
+     */
+    'x-correlator'?: string;
+}
+export declare namespace KnowyourcustomerfillIn {
+    export { type KnowyourcustomerfillInCreateResponse as KnowyourcustomerfillInCreateResponse, type KnowyourcustomerfillInCreateParams as KnowyourcustomerfillInCreateParams, };
+}
+//# sourceMappingURL=knowyourcustomerfill-in.d.ts.map

package/resources/knowyourcustomerfill-in.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowyourcustomerfill-in.d.ts","sourceRoot":"","sources":["../src/resources/knowyourcustomerfill-in.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;CAWpD;AAED,MAAM,WAAW,oCAAoC;IACnD;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IAErC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EACX,UAAU,GACV,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,oBAAoB,GACpB,OAAO,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kCAAkC;IACjD;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kCAAkC,IAAI,kCAAkC,GAC9E,CAAC;CACH"}