/** * This file was auto-generated by openapi-typescript and ts-morph. * Do not make direct changes to the file. */ export interface paths { readonly "/login/token/{jwt_token}": { readonly parameters: { readonly query?: never; readonly path?: never; readonly cookie?: never; }; /** * Login Token * @description The customer login access point URL. * * [Learn more about the Customer Login API](/docs/start/authentication/customer-login). * * ## Example * * ``` * https://yourstore.example.com/login/token/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ7Y2xpZW50X2lkfSIsImlhdCI6MTUzNTM5MzExMywianRpIjoie3V1aWR9Iiwib3BlcmF0aW9uIjoiY3VzdG9tZXJfbG9naW4iLCJzdG9yZV9oYXNoIjoie3N0b3JlX2hhc2h9IiwiY3VzdG9tZXJfaWQiOjJ9.J-fAtbjRFGdLsT744DhoprFEDqIfVq72HbDzrbFy6Is * ``` */ readonly get: operations["getCustomerLogin"]; }; } export type webhooks = Record; export interface components { schemas: { /** Customer Login SSO */ readonly customerLoginSSO: { /** * @description Indicates the token’s issuer. This is your application’s client ID, which is obtained during application registration in Developer Portal. * @example "1234r5t6y7u8i9o0p" */ readonly iss?: string; /** * @description Time when the token was generated. This is a numeric value indicating the number of seconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time). * @example 1535393113 */ readonly iat?: number; /** * @description Request ID string that must be unique across all requests made by your app. A UUID or other random string would be an appropriate value. Most libraries contain a method for generating a uuid. For testing a [UUID generator](https://www.uuidgenerator.net/) can be used, but it recommended to use built in libraries. * @example "20b7c03e-00da-4d29-91bf-2aa06a57575b" */ readonly jti?: string; /** * @description Must contain the string “customer_login”. * @example "customer_login" */ readonly operation?: string; /** * @description Store hash identifying the store you are logging into. * * @example "abc123" */ readonly store_hash?: string; /** * @description ID of the customer you are logging in, as obtained through the Customer API. * * @example 2 */ readonly customer_id?: number; /** * @description Optional field containing a relative path for the shopper’s destination after login. Will default to `/account.php`. * * @default /account.php */ readonly redirect_to: string; /** * @description **(Optional)** Field containing the expected IP address for the request. If provided, BigCommerce will check that it matches the browser trying to log in. If there is not a match, it will be rejected. * * @example "111.222.333.444" */ readonly request_ip?: string; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { readonly getCustomerLogin: { readonly parameters: { readonly query?: never; readonly header?: never; readonly path: { readonly jwt_token: string; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { /** @description OK */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { readonly "*/*": { readonly [key: string]: unknown; }; }; }; }; }; }