Options
All
  • Public
  • Public/Protected
  • All
Menu

Module sdk-full/models/customer

Index

Type aliases

Type aliases

CreateCustomerAddressInput

CreateCustomerAddressInput: { addressDetails: string; addressNumber: string; cep: string; city: string; name: string; neighborhood: string; receiverName: string; referencePoint: string; state: string; street: string }

Type declaration

  • addressDetails: string
  • addressNumber: string
  • cep: string
  • city: string
  • name: string
  • neighborhood: string
  • receiverName: string
  • referencePoint: string
  • state: string
  • street: string

CustomerAccessTokenDetailsData

CustomerAccessTokenDetailsData: { accessKey: boolean; customerId: number; identifier: string; isMaster: boolean; masterUserId: number | null; origin: string; type: string; validUntil: string }

Type declaration

  • accessKey: boolean
  • customerId: number
  • identifier: string
  • isMaster: boolean
  • masterUserId: number | null
  • origin: string
  • type: string
  • validUntil: string

CustomerAccessTokenRenewData

CustomerAccessTokenRenewData: { token: string; validUntil: string }

Type declaration

  • token: string
  • validUntil: string

CustomerAddressData

CustomerAddressData: { addressDetails: string; addressNumber: string; cep: string; city: string; id: string; name: string; neighborhood: string; receiverName: string; referencePoint: string; state: string; street: string }

Type declaration

  • addressDetails: string
  • addressNumber: string
  • cep: string
  • city: string
  • id: string
  • name: string
  • neighborhood: string
  • receiverName: string
  • referencePoint: string
  • state: string
  • street: string

CustomerAddressRemoveData

CustomerAddressRemoveData: { isSuccess: boolean }

Type declaration

  • isSuccess: boolean

CustomerAuthenticateAccessKeyData

CustomerAuthenticateAccessKeyData: { token: string; validUntil: string }

Type declaration

  • token: string
  • validUntil: string

CustomerAuthenticatedLoginData

CustomerAuthenticatedLoginData: { isMaster: boolean; partners?: CustomerAuthenticatedLoginPartner[]; token: string; validUntil: string }

Type declaration

CustomerAuthenticatedLoginPartner

CustomerAuthenticatedLoginPartner: { alias: string; endDate: string; fullUrlLogo: string; name: string; partnerAccessToken: string }

Type declaration

  • alias: string
  • endDate: string
  • fullUrlLogo: string
  • name: string
  • partnerAccessToken: string

CustomerAuthenticatedLoginWith2FAData

CustomerAuthenticatedLoginWith2FAData: { email: string }

First step of a two-factor login. Carries no token on purpose: the login is only complete after passing this email to authenticateAccessKey.

Type declaration

  • email: string

CustomerCompletePartialRegistrationData

CustomerCompletePartialRegistrationData: { isMaster: boolean; token: string; type: string; validUntil: string }

Type declaration

  • isMaster: boolean
  • token: string
  • type: string
  • validUntil: string

CustomerCreateData

CustomerCreateData: { customerId: string; customerName: string; customerType: string; email: string }

Type declaration

  • customerId: string
  • customerName: string
  • customerType: string
  • email: string

CustomerCreateInput

CustomerCreateInput: { address?: string; address2?: string; addressComplement?: string; addressNumber?: string; birthDate?: string; cep?: string; city?: string; cnpj?: string; corporateName?: string; country?: string; cpf?: string; customerType: string; email: string; fullName: string; gender?: string; informationGroupValues?: { id: string; value: string }[]; isStateRegistrationExempt?: boolean; neighborhood?: string; newsletter?: boolean; password: string; passwordConfirmation: string; primaryPhoneAreaCode?: string; primaryPhoneNumber?: string; receiverName?: string; reference?: string; reseller?: boolean; secondaryPhoneAreaCode?: string; secondaryPhoneNumber?: string; state?: string; stateRegistration?: string }

Type declaration

  • Optional address?: string
  • Optional address2?: string
  • Optional addressComplement?: string
  • Optional addressNumber?: string
  • Optional birthDate?: string
  • Optional cep?: string
  • Optional city?: string
  • Optional cnpj?: string
  • Optional corporateName?: string
  • Optional country?: string
  • Optional cpf?: string
  • customerType: string
  • email: string
  • fullName: string
  • Optional gender?: string
  • Optional informationGroupValues?: { id: string; value: string }[]
  • Optional isStateRegistrationExempt?: boolean
  • Optional neighborhood?: string
  • Optional newsletter?: boolean
  • password: string
  • passwordConfirmation: string
  • Optional primaryPhoneAreaCode?: string
  • Optional primaryPhoneNumber?: string
  • Optional receiverName?: string
  • Optional reference?: string
  • Optional reseller?: boolean
  • Optional secondaryPhoneAreaCode?: string
  • Optional secondaryPhoneNumber?: string
  • Optional state?: string
  • Optional stateRegistration?: string

CustomerData

CustomerData: { cnpj?: string; companyName?: string; cpf?: string; customerName: string; customerType: string; email: string; id: string; phoneNumber?: string }

Type declaration

  • Optional cnpj?: string
  • Optional companyName?: string
  • Optional cpf?: string
  • customerName: string
  • customerType: string
  • email: string
  • id: string
  • Optional phoneNumber?: string

CustomerEmailChangeData

CustomerEmailChangeData: { isSuccess: boolean }

Type declaration

  • isSuccess: boolean

CustomerImpersonateData

CustomerImpersonateData: { token: string; validUntil: string }

Type declaration

  • token: string
  • validUntil: string

CustomerPasswordChangeData

CustomerPasswordChangeData: { isSuccess: boolean }

Type declaration

  • isSuccess: boolean

CustomerPasswordRecoveryData

CustomerPasswordRecoveryData: { isSuccess: boolean }

Type declaration

  • isSuccess: boolean

CustomerSendAccessKeyEmailData

CustomerSendAccessKeyEmailData: { isSuccess: boolean }

Type declaration

  • isSuccess: boolean

CustomerSimpleCreateInputGraphInput

CustomerSimpleCreateInputGraphInput: { birthDate?: string; cnpj?: string; corporateName?: string; cpf?: string; customerType: string; email: string; fullName: string; isStateRegistrationExempt?: boolean; primaryPhoneAreaCode: string; primaryPhoneNumber: string; stateRegistration?: string }

Type declaration

  • Optional birthDate?: string
  • Optional cnpj?: string
  • Optional corporateName?: string
  • Optional cpf?: string
  • customerType: string
  • email: string
  • fullName: string
  • Optional isStateRegistrationExempt?: boolean
  • primaryPhoneAreaCode: string
  • primaryPhoneNumber: string
  • Optional stateRegistration?: string

CustomerSimpleLoginStartData

CustomerSimpleLoginStartData: { customerAccessToken: { token: string; type: string; validUntil: string }; question: { answers: { id: string; value: string }[]; question: string; questionId: string }; type: string }

Type declaration

  • customerAccessToken: { token: string; type: string; validUntil: string }
    • token: string
    • type: string
    • validUntil: string
  • question: { answers: { id: string; value: string }[]; question: string; questionId: string }
    • answers: { id: string; value: string }[]
    • question: string
    • questionId: string
  • type: string

CustomerSimpleLoginVerifyAnswerData

CustomerSimpleLoginVerifyAnswerData: { customerAccessToken: { isMaster: boolean; token: string; type: string; validUntil: string }; question: { answers: { id: string; value: string }[]; question: string; questionId: string }; type: string }

Type declaration

  • customerAccessToken: { isMaster: boolean; token: string; type: string; validUntil: string }
    • isMaster: boolean
    • token: string
    • type: string
    • validUntil: string
  • question: { answers: { id: string; value: string }[]; question: string; questionId: string }
    • answers: { id: string; value: string }[]
    • question: string
    • questionId: string
  • type: string

CustomerSocialLoginAppleData

CustomerSocialLoginAppleData: { isMaster: boolean; partners?: CustomerAuthenticatedLoginPartner[]; token: string; type: string; validUntil: string }

Type declaration

CustomerSocialLoginFacebookData

CustomerSocialLoginFacebookData: { isMaster: boolean; partners?: CustomerAuthenticatedLoginPartner[]; token: string; type: string; validUntil: string }

Type declaration

CustomerSocialLoginGoogleData

CustomerSocialLoginGoogleData: { isMaster: boolean; partners?: CustomerAuthenticatedLoginPartner[]; token: string; type: string; validUntil: string }

Type declaration

CustomerSubscriptionAddressChangeData

CustomerSubscriptionAddressChangeData: { address: { address: string; addressDetails: string; addressNumber: string; cep: string; city: string; country: string; id: string; neighborhood: string; state: string } }

Type declaration

  • address: { address: string; addressDetails: string; addressNumber: string; cep: string; city: string; country: string; id: string; neighborhood: string; state: string }
    • address: string
    • addressDetails: string
    • addressNumber: string
    • cep: string
    • city: string
    • country: string
    • id: string
    • neighborhood: string
    • state: string

CustomerSubscriptionChangeCardData

CustomerSubscriptionChangeCardData: { subscriptions: { subscriptionId: number }[] }

Type declaration

  • subscriptions: { subscriptionId: number }[]

CustomerSubscriptionProductAddInput

CustomerSubscriptionProductAddInput: { productVariantId: number; quantity: number }

Type declaration

  • productVariantId: number
  • quantity: number

CustomerSubscriptionProductData

CustomerSubscriptionProductData: { subscriptions: { subscriptionId: number }[] }

Type declaration

  • subscriptions: { subscriptionId: number }[]

CustomerSubscriptionProductRemoveInput

CustomerSubscriptionProductRemoveInput: { subscriptionProductId: number }

Type declaration

  • subscriptionProductId: number

CustomerSubscriptionUpdateStatusData

CustomerSubscriptionUpdateStatusData: { subscriptions: { status: string; subscriptionId: number }[] }

Type declaration

  • subscriptions: { status: string; subscriptionId: number }[]

CustomerUpdateData

CustomerUpdateData: { customerId: string; customerName: string; customerType: string; email: string }

Type declaration

  • customerId: string
  • customerName: string
  • customerType: string
  • email: string

CustomerUpdateInput

CustomerUpdateInput: { birthDate?: string; corporateName?: string; fullName?: string; gender?: string; informationGroupValues?: { id: string; value: string }[]; isStateRegistrationExempt?: boolean; primaryPhoneNumber?: string; primaryPhoneNumberInternational?: string; rg?: string; secondaryPhoneNumber?: string; secondaryPhoneNumberInternational?: string; stateRegistration?: string }

Type declaration

  • Optional birthDate?: string
  • Optional corporateName?: string
  • Optional fullName?: string
  • Optional gender?: string
  • Optional informationGroupValues?: { id: string; value: string }[]
  • Optional isStateRegistrationExempt?: boolean
  • Optional primaryPhoneNumber?: string
  • Optional primaryPhoneNumberInternational?: string
  • Optional rg?: string
  • Optional secondaryPhoneNumber?: string
  • Optional secondaryPhoneNumberInternational?: string
  • Optional stateRegistration?: string

UpdateCustomerAddressInput

UpdateCustomerAddressInput: { addressDetails: string; addressNumber: string; cep: string; city: string; name: string; neighborhood: string; receiverName: string; referencePoint: string; state: string; street: string }

Type declaration

  • addressDetails: string
  • addressNumber: string
  • cep: string
  • city: string
  • name: string
  • neighborhood: string
  • receiverName: string
  • referencePoint: string
  • state: string
  • street: string

Generated using TypeDoc